From: Fred Drake <fdrake@acm.org>
Date: Thu, 21 Jun 2001 18:56:49 +0000 (+0000)
Subject: Added documentation for PyErr_SetFromErrnoWithFilename().
X-Git-Tag: v2.1.1c1~71
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=495739f8b2de68887204ec852f67c7ed4e2ecf1d;p=thirdparty%2FPython%2Fcpython.git

Added documentation for PyErr_SetFromErrnoWithFilename().
---

diff --git a/Doc/api/api.tex b/Doc/api/api.tex
index 3fef8432a904..5cc3dfdfa05a 100644
--- a/Doc/api/api.tex
+++ b/Doc/api/api.tex
@@ -951,6 +951,16 @@ returns \NULL{}, so a wrapper function around a system call can write
 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