Added documentation for PyErr_SetFromErrnoWithFilename().

freddrake · freddrake · commit c334b3af3cc6 · 2001-06-21T18:58:39.000Z
diff --git a/Doc/api/api.tex b/Doc/api/api.tex
@@ -934,6 +934,16 @@ \chapter{Exception Handling \label{exceptionHandling}}
 error.
 \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,
 \var{message})}, where \var{message} indicates that an internal
