[Python-checkins] python/dist/src/Doc/api init.tex,1.8,1.9

fdrake@users.sourceforge.net fdrake@users.sourceforge.net
Sat, 28 Jun 2003 19:14:33 -0700


Update of /cvsroot/python/python/dist/src/Doc/api
In directory sc8-pr-cvs1:/tmp/cvs-serv27640/api

Modified Files:
	init.tex 
Log Message:
Document PyThreadState_SetAsyncExc().

Index: init.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/api/init.tex,v
retrieving revision 1.8
retrieving revision 1.9
diff -C2 -d -r1.8 -r1.9
*** init.tex	15 Apr 2003 15:10:49 -0000	1.8
--- init.tex	29 Jun 2003 02:14:31 -0000	1.9
***************
*** 686,689 ****
--- 686,703 ----
  \end{cfuncdesc}
  
+ \begin{cfuncdesc}{int}{PyThreadState_SetAsyncExc}{long id, PyObject *exc}
+   Asynchronously raise an exception in a thread. 
+   The \var{id} argument is the thread id of the target thread;
+   \var{exc} is the exception object to be raised.
+   This function does not steal any references to \var{exc}.
+   To prevent naive misuse, you must write your own C extension 
+   to call this.  Must be called with the GIL held. 
+   Returns the number of thread states modified; if it returns a number 
+   greater than one, you're in trouble, and you should call it again 
+   with \var{exc} set to \constant{NULL} to revert the effect.
+   This raises no exceptions.
+   \versionadded{2.3}
+ \end{cfuncdesc}
+ 
  
  \section{Profiling and Tracing \label{profiling}}