From 891150bdf2773b9e8ad9e92db073805afd7722cd Mon Sep 17 00:00:00 2001 From: Fred Drake Date: Sat, 23 Sep 2000 03:25:42 +0000 Subject: [PATCH] Added documentation for the new PyModule_*() convenience functions. This closes SourceForge patch #101233. --- Doc/api/api.tex | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/Doc/api/api.tex b/Doc/api/api.tex index 0a475f695a6..6ce5f291211 100644 --- a/Doc/api/api.tex +++ b/Doc/api/api.tex @@ -3680,6 +3680,32 @@ or if it is not a string, raise \exception{SystemError} and return \withsubitem{(built-in exception)}{\ttindex{SystemError}} \end{cfuncdesc} +\begin{cfuncdesc}{int}{PyModule_AddObject}{PyObject *module, + char *name, PyObject *value} +Add an object to \var{module} as \var{name}. This is a convenience +function which can be used from the module's initialization function. +This steals a reference to \var{value}. Returns \code{-1} on error, +\code{0} on success. +\versionadded{2.0} +\end{cfuncdesc} + +\begin{cfuncdesc}{int}{PyModule_AddIntConstant}{PyObject *module, + char *name, int value} +Add an integer constant to \var{module} as \var{name}. This convenience +function can be used from the module's initialization function. +Returns \code{-1} on error, \code{0} on success. +\versionadded{2.0} +\end{cfuncdesc} + +\begin{cfuncdesc}{int}{PyModule_AddStringConstant}{PyObject *module, + char *name, char *value} +Add a string constant to \var{module} as \var{name}. This convenience +function can be used from the module's initialization function. The +string \var{value} must be null-terminated. Returns \code{-1} on +error, \code{0} on success. +\versionadded{2.0} +\end{cfuncdesc} + \subsection{CObjects \label{cObjects}}