[Python-checkins] CVS: python/dist/src/Doc/api api.tex,1.117.2.5,1.117.2.6

[Fred L. Drake]

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

Modified Files:
      Tag: release21-maint
	api.tex 
Log Message:

Added documentation for PyErr_SetFromErrnoWithFilename().


Index: api.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/api/api.tex,v
retrieving revision 1.117.2.5
retrieving revision 1.117.2.6
diff -C2 -r1.117.2.5 -r1.117.2.6
*** api.tex	2001/06/21 18:52:50	1.117.2.5
--- api.tex	2001/06/21 18:56:49	1.117.2.6
***************
*** 952,955 ****
--- 952,965 ----
  \end{cfuncdesc}
  
+ \begin{cfuncdesc}{PyObject*}{PyErr_SetFromErrnoWithFilename}{PyObject *type,
+                                                              char *filename}
+ Similar to \cfunction{PyErr_SetFromErrno()}, with the additional
+ behavior that if \var{filename} is not \NULL, it is passed to the
+ constructor of \var{type} as a third parameter.  In the case of
+ exceptions such as \exception{IOError} and \exception{OSError}, this
+ is used to define the \member{filename} attribute of the exception
+ instance.
+ \end{cfuncdesc}
+ 
  \begin{cfuncdesc}{void}{PyErr_BadInternalCall}{}
  This is a shorthand for \samp{PyErr_SetString(PyExc_TypeError,