From: Thomas Heller <theller@ctypes.org>
Date: Tue, 2 Jul 2002 15:47:03 +0000 (+0000)
Subject: Docs for PyErr_SetFromWindowsErrWithFilename() and
X-Git-Tag: v2.3c1~5139
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=4f2722ac9b2a481dff1059416c9fa903d002153c;p=thirdparty%2FPython%2Fcpython.git

Docs for PyErr_SetFromWindowsErrWithFilename() and
PyErr_SetFromWindowsErr().
Fixes SF# 576016, with additional markup.
---

diff --git a/Doc/api/exceptions.tex b/Doc/api/exceptions.tex
index 5bd91177af8d..57ba8b8146b2 100644
--- a/Doc/api/exceptions.tex
+++ b/Doc/api/exceptions.tex
@@ -193,6 +193,29 @@ for each thread.
   instance.
 \end{cfuncdesc}
 
+\begin{cfuncdesc}{PyObject*}{PyErr_SetFromWindowsErr}{int ierr}
+  This is a convenience function to raise
+  \exception{PyExc_WindowsError}.  If called with \var{ierr} of
+  \cdata{0}, the error code returned by a call to
+  \cfunction{GetLastError()} is used instead.  It calls the win32
+  function \cfunction{FormatMessage()} to retrieve the Windows
+  description of error code \var{ierr}, then it constructs a tuple object
+  whose first item is the integer \cdata{ierr} value and whose second
+  item is the corresponding error message (gotten from
+  \cfunction{FormatMessage()}), and then calls
+  \samp{PyErr_SetObject(\var{PyExc_WindowsError}, \var{object})}.
+  This function always returns \NULL.  This function is only available
+  on Windows.
+\end{cfuncdesc}
+
+\begin{cfuncdesc}{PyObject*}{PyErr_SetFromWindowsErrWithFilename}{int ierr,
+                                                                  char *filename}
+  Similar to \cfunction{PyErr_SetFromWindowsErr()}, with the
+  additional behavior that if \var{filename} is not \NULL, it is
+  passed to the constructor of \exception{WindowsError} as a third
+  parameter.  This function is only available on Windows.
+\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