Fred Drake avatar Fred Drake committed 76c3ff5

Added documentation for PyErr_SetFromErrnoWithFilename().

Comments (0)

Files changed (1)

 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
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.