Extend PyWin_SetAPIError

mhammond · Mar 17, 2024 · 7145515 · 7145515
1 parent e0fda45
commit 7145515
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 2 deletions.
diff --git a/win32/src/PyWinTypes.h b/win32/src/PyWinTypes.h
@@ -101,7 +101,7 @@ extern PYWINTYPES_EXPORT BOOL PyWin_RegisterErrorMessageModule(DWORD first, DWOR
 extern PYWINTYPES_EXPORT HINSTANCE PyWin_GetErrorMessageModule(DWORD err);
 
 /* A global function that sets an API style error (ie, (code, fn, errTest)) */
-PYWINTYPES_EXPORT PyObject *PyWin_SetAPIError(char *fnName, long err = 0);
+PYWINTYPES_EXPORT PyObject *PyWin_SetAPIError(const char *fnName, long err = 0, bool returnNoneOnSuccess = false);
 
 /* Basic COM Exception handling.  The main COM exception object
    is actually defined here.  However, the most useful functions

diff --git a/win32/src/PyWinTypesmodule.cpp b/win32/src/PyWinTypesmodule.cpp
@@ -275,9 +275,11 @@ HINSTANCE PyWin_GetErrorMessageModule(DWORD err)
 }
 
 /* error helper - GetLastError() is provided, but this is for exceptions */
-PyObject *PyWin_SetAPIError(char *fnName, long err /*= 0*/)
+PyObject *PyWin_SetAPIError(const char *fnName, long err /*= 0*/, bool returnNoneOnSuccess /*= false*/)
 {
     DWORD errorCode = err == 0 ? GetLastError() : err;
+    if ((returnNoneOnSuccess) && (!errorCode))
+        Py_RETURN_NONE;
     DWORD flags = FORMAT_MESSAGE_FROM_SYSTEM | FORMAT_MESSAGE_ALLOCATE_BUFFER | FORMAT_MESSAGE_IGNORE_INSERTS;
     // try and find the hmodule providing this error.
     HMODULE hmodule = PyWin_GetErrorMessageModule(errorCode);