diff options
author | Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com> | 2024-04-17 10:28:55 (GMT) |
---|---|---|
committer | GitHub <noreply@github.com> | 2024-04-17 10:28:55 (GMT) |
commit | ac48fdeb0d26c50754eedddfa865b27542dfaeb7 (patch) | |
tree | ee533a8fc633114152bb052ab5f1f6c1f776f3f8 | |
parent | 0a40580b854c74f57b9784fa5bccc1e897e437d2 (diff) | |
download | cpython-ac48fdeb0d26c50754eedddfa865b27542dfaeb7.zip cpython-ac48fdeb0d26c50754eedddfa865b27542dfaeb7.tar.gz cpython-ac48fdeb0d26c50754eedddfa865b27542dfaeb7.tar.bz2 |
[3.12] gh-73231: Update documentation for PyErr_SetFromWindowsErr() (GH-117226) (GH-117973)
(cherry picked from commit 438b7c3071eebaccd1ba215f15a239345b22f813)
Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
-rw-r--r-- | Doc/c-api/exceptions.rst | 9 |
1 files changed, 5 insertions, 4 deletions
diff --git a/Doc/c-api/exceptions.rst b/Doc/c-api/exceptions.rst index dd49d2d..7ddecb2 100644 --- a/Doc/c-api/exceptions.rst +++ b/Doc/c-api/exceptions.rst @@ -208,13 +208,14 @@ For convenience, some of these functions will always return a .. c:function:: PyObject* PyErr_SetFromWindowsErr(int ierr) - This is a convenience function to raise :exc:`WindowsError`. If called with + This is a convenience function to raise :exc:`OSError`. If called with *ierr* of ``0``, the error code returned by a call to :c:func:`!GetLastError` is used instead. It calls the Win32 function :c:func:`!FormatMessage` to retrieve the Windows description of error code given by *ierr* or :c:func:`!GetLastError`, - then it constructs a tuple object whose first item is the *ierr* value and whose - second item is the corresponding error message (gotten from - :c:func:`!FormatMessage`), and then calls ``PyErr_SetObject(PyExc_WindowsError, + then it constructs a :exc:`OSError` object with the :attr:`~OSError.winerror` + attribute set to the error code, the :attr:`~OSError.strerror` attribute + set to the corresponding error message (gotten from + :c:func:`!FormatMessage`), and then calls ``PyErr_SetObject(PyExc_OSError, object)``. This function always returns ``NULL``. .. availability:: Windows. |