Add documentation for Py_Main() and PyThreadState_GetDict().

freddrake · freddrake · commit 24e621918bc0 · 2001-05-21T15:56:55.000Z
diff --git a/Doc/api/api.tex b/Doc/api/api.tex
@@ -609,6 +609,19 @@ \chapter{The Very High Level Layer \label{veryhigh}}
 to these functions if it is certain that they were created by the same
 library that the Python runtime is using.
 
+\begin{cfuncdesc}{int}{Py_Main}{int argc, char **argv}
+  The main program for the standard interpreter.  This is made
+  available for programs which embed Python.  The \var{argc} and
+  \var{argv} parameters should be prepared exactly as those which are
+  passed to a C program's \cfunction{main()} function.  It is
+  important to note that the argument list may be modified (but the
+  contents of the strings pointed to by the argument list are not).
+  The return value will be the integer passed to the
+  \function{sys.exit()} function, \code{1} if the interpreter exits
+  due to an exception, or \code{2} if the parameter list does not
+  represent a valid Python command line.
+\end{cfuncdesc}
+
 \begin{cfuncdesc}{int}{PyRun_AnyFile}{FILE *fp, char *filename}
   If \var{fp} refers to a file associated with an interactive device
   (console or terminal input or \UNIX{} pseudo-terminal), return the
@@ -4631,6 +4644,14 @@ \section{Thread State and the Global Interpreter Lock
 must be held.
 \end{cfuncdesc}
 
+\begin{cfuncdesc}{PyObject*}{PyThreadState_GetDict}{}
+Return a dictionary in which extensions can store thread-specific
+state information.  Each extension should use a unique key to use to
+store state in the dictionary.  If this function returns \NULL, an
+exception has been raised and the caller should allow it to
+propogate.
+\end{cfuncdesc}
+
 
 \chapter{Memory Management \label{memory}}
 \sectionauthor{Vladimir Marangozov}{Vladimir.Marangozov@inrialpes.fr}
