Py_AtExit(): Added brief note about the constraint on cleanup functions not
calling the Python API.
This commit is contained in:
parent
25f1722dd7
commit
c6c921a4de
15
Doc/api.tex
15
Doc/api.tex
|
@ -542,12 +542,15 @@ calls the standard \C{} library function \code{exit(0)}.
|
|||
\end{cfuncdesc}
|
||||
|
||||
\begin{cfuncdesc}{int}{Py_AtExit}{void (*func) ()}
|
||||
Register a cleanup function to be called by \code{Py_Finalize()}. The
|
||||
cleanup function will be called with no arguments and should return no
|
||||
value. At most 32 cleanup functions can be registered. When the
|
||||
registration is successful, \code{Py_AtExit} returns 0; on failure, it
|
||||
returns -1. The cleanup function registered last is called first.
|
||||
Each cleanup function will be called at most once.
|
||||
Register a cleanup function to be called by \cfunction{Py_Finalize()}.
|
||||
The cleanup function will be called with no arguments and should
|
||||
return no value. At most 32 cleanup functions can be registered.
|
||||
When the registration is successful, \cfunction{Py_AtExit()} returns
|
||||
\code{0}; on failure, it returns \code{-1}. The cleanup function
|
||||
registered last is called first. Each cleanup function will be called
|
||||
at most once. Since Python's internal finallization will have
|
||||
completed before the cleanup function, no Python APIs should be called
|
||||
by \var{func}.
|
||||
\end{cfuncdesc}
|
||||
|
||||
|
||||
|
|
|
@ -542,12 +542,15 @@ calls the standard \C{} library function \code{exit(0)}.
|
|||
\end{cfuncdesc}
|
||||
|
||||
\begin{cfuncdesc}{int}{Py_AtExit}{void (*func) ()}
|
||||
Register a cleanup function to be called by \code{Py_Finalize()}. The
|
||||
cleanup function will be called with no arguments and should return no
|
||||
value. At most 32 cleanup functions can be registered. When the
|
||||
registration is successful, \code{Py_AtExit} returns 0; on failure, it
|
||||
returns -1. The cleanup function registered last is called first.
|
||||
Each cleanup function will be called at most once.
|
||||
Register a cleanup function to be called by \cfunction{Py_Finalize()}.
|
||||
The cleanup function will be called with no arguments and should
|
||||
return no value. At most 32 cleanup functions can be registered.
|
||||
When the registration is successful, \cfunction{Py_AtExit()} returns
|
||||
\code{0}; on failure, it returns \code{-1}. The cleanup function
|
||||
registered last is called first. Each cleanup function will be called
|
||||
at most once. Since Python's internal finallization will have
|
||||
completed before the cleanup function, no Python APIs should be called
|
||||
by \var{func}.
|
||||
\end{cfuncdesc}
|
||||
|
||||
|
||||
|
|
Loading…
Reference in New Issue