[Python-checkins] python/dist/src/Doc/api exceptions.tex,1.6,1.7

fdrake@users.sourceforge.net fdrake@users.sourceforge.net
Tue, 02 Jul 2002 09:18:00 -0700


Update of /cvsroot/python/python/dist/src/Doc/api
In directory usw-pr-cvs1:/tmp/cvs-serv24961

Modified Files:
	exceptions.tex 
Log Message:
Minor markup adjustments, consistency changes, and shorten a long
line.


Index: exceptions.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/api/exceptions.tex,v
retrieving revision 1.6
retrieving revision 1.7
diff -C2 -d -r1.6 -r1.7
*** exceptions.tex	2 Jul 2002 15:47:03 -0000	1.6
--- exceptions.tex	2 Jul 2002 16:17:58 -0000	1.7
***************
*** 195,218 ****
  
  \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}
  
--- 195,219 ----
  
  \begin{cfuncdesc}{PyObject*}{PyErr_SetFromWindowsErr}{int ierr}
!   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.
!   Availability: 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.
!   Availability: Windows.
  \end{cfuncdesc}