summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorFred Drake <fdrake@acm.org>2002-07-02 16:17:58 (GMT)
committerFred Drake <fdrake@acm.org>2002-07-02 16:17:58 (GMT)
commitabe7c1a4afd289e8e2b953241e5c1f12a5bc2071 (patch)
tree0bda5a3f75415704fd75e8a53e0a08976390316e
parent7c1bb9c528640ae7cfd172727e4794594f864908 (diff)
downloadcpython-abe7c1a4afd289e8e2b953241e5c1f12a5bc2071.zip
cpython-abe7c1a4afd289e8e2b953241e5c1f12a5bc2071.tar.gz
cpython-abe7c1a4afd289e8e2b953241e5c1f12a5bc2071.tar.bz2
Minor markup adjustments, consistency changes, and shorten a long
line.
-rw-r--r--Doc/api/exceptions.tex25
1 files changed, 13 insertions, 12 deletions
diff --git a/Doc/api/exceptions.tex b/Doc/api/exceptions.tex
index 57ba8b8..7375dd7 100644
--- a/Doc/api/exceptions.tex
+++ b/Doc/api/exceptions.tex
@@ -194,26 +194,27 @@ for each thread.
\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
+ This is a convenience function to raise \exception{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 given by \var{ierr} or
+ \cfunction{GetLastError()}, then it constructs a tuple object whose
+ first item is the \var{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.
+ This function always returns \NULL.
+ Availability: Windows.
\end{cfuncdesc}
\begin{cfuncdesc}{PyObject*}{PyErr_SetFromWindowsErrWithFilename}{int ierr,
- char *filename}
+ 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.
+ parameter.
+ Availability: Windows.
\end{cfuncdesc}
\begin{cfuncdesc}{void}{PyErr_BadInternalCall}{}