Error handling function (Win32/C)Suggestions for improving error handlingError handling for function calls to parse a GIF fileWin32 GDI+ memory and styleHandling an invalid SQL query exceptionEasy error handlingErrno-like C global error handlingAutomated document downloading, with error handlingRead and write BMP file in CError-Handling Class and Logging for VBA#Error Handling- Propagating errors to calling function.

Consistent Linux device enumeration

Do people actually use the word "kaputt" in conversation?

Make a border of symbols in Gimp

Limit max CPU usage SQL SERVER with WSRM

Why the "ls" command is showing the permissions of files in a FAT32 partition?

Quoting Keynes in a lecture

El Dorado Word Puzzle II: Videogame Edition

How would a solely written language work mechanically

What should be the ideal length of sentences in a blog post for ease of reading?

Should I assume I have passed probation?

Why would five hundred and five be same as one?

Do you waste sorcery points if you try to apply metamagic to a spell from a scroll but fail to cast it?

Air travel with refrigerated insulin

Adding up numbers in Portuguese is strange

How to understand "he realized a split second too late was also a mistake"

How to get directions in deep space?

Possible Eco thriller, man invents a device to remove rain from glass

Determining multivariate least squares with constraint

Given this phrasing in the lease, when should I pay my rent?

What does "tick" mean in this sentence?

Why didn’t Eve recognize the little cockroach as a living organism?

Why does a 97 / 92 key piano exist by Bösendorfer?

The Digit Triangles

Confusion over Hunter with Crossbow Expert and Giant Killer



Error handling function (Win32/C)


Suggestions for improving error handlingError handling for function calls to parse a GIF fileWin32 GDI+ memory and styleHandling an invalid SQL query exceptionEasy error handlingErrno-like C global error handlingAutomated document downloading, with error handlingRead and write BMP file in CError-Handling Class and Logging for VBA#Error Handling- Propagating errors to calling function.













0












$begingroup$


I have written the following function to be a general "error logging" solution for my Windows API projects. Basically, given a Windows system error code (a la GetLastError()), it will log the error message into a file:



#include <Windows.h>
#include <strsafe.h>

// MAX_PATH for file name, 12 for max signed int in base 10 (-2147483648), 20 for datetime string, 5 for brackets/colon/spaces
#define MAX_DFL_LENGTH (MAX_PATH + 37)

// So that it can be used as a callback if desired
typedef VOID(CALLBACK *ERRORPROC)(DWORD, WCHAR *, INT, HANDLE, BOOL);

/**
* Logs an error message that occurred elsewhere in the program.
* PARAMETERS:
* dwError - The system error code to process.
* wszFileName - The name of the file in which the error occurred (pass __FILEW__)
* nLine - The line at which the error was detected (pass __LINE__)
* hOutFile - A handle to an already open file for writing the error message to.
* fRecoverable - If true, this error is recoverable; return to the calling code. If false, exit after logging the error.
*/
VOID CALLBACK ErrorProc(
DWORD dwError,
WCHAR *wszFileName,
INT nLine,
HANDLE hOutFile,
BOOL fRecoverable
)
FORMAT_MESSAGE_IGNORE_INSERTS,
NULL,
dwError,
MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT),
(LPVOID)&lpMsgBuf,
0,
NULL
);

GetLocalTime(&st);
StringCchPrintfW(
wszDateFileLine,
MAX_DFL_LENGTH,
L"[%.4hu-%.2hu-%.2huT%.2hu:%.2hu:%.2hu %s:%d] ",
st.wYear,
st.wMonth,
st.wDay,
st.wHour,
st.wMinute,
st.wSecond,
wszFileName,
nLine
);

SetFilePointer(hOutFile, 0, NULL, FILE_END);
hr = StringCbLengthW(wszDateFileLine, (MAX_DFL_LENGTH) * sizeof(WCHAR), &uLen);
if (SUCCEEDED(hr))

WriteFile(hOutFile, wszDateFileLine, uLen, &dwWritten, NULL);


hr = StringCbLengthW(lpMsgBuf, STRSAFE_MAX_CCH * sizeof(WCHAR), &uLen);
if (SUCCEEDED(hr))

// Length - 2 WCHARs to not write out the rn at the end of the error message.
WriteFile(hOutFile, lpMsgBuf, uLen - (2 * sizeof(WCHAR)), &dwWritten, NULL);


WriteFile(hOutFile, wRecovMsg[!!fRecoverable], (36 + (!!fRecoverable * 3)) * sizeof(WCHAR), &dwWritten, NULL);
LocalFree((HLOCAL)lpMsgBuf);

if (FALSE == fRecoverable)

ExitProcess(dwError);




While this historically worked well enough for my personal projects, I am wondering if there are any modifications I should make to the presentation or operation of this function before suggesting its addition to a larger Windows project with an entire team of developers.









share









$endgroup$
















    0












    $begingroup$


    I have written the following function to be a general "error logging" solution for my Windows API projects. Basically, given a Windows system error code (a la GetLastError()), it will log the error message into a file:



    #include <Windows.h>
    #include <strsafe.h>

    // MAX_PATH for file name, 12 for max signed int in base 10 (-2147483648), 20 for datetime string, 5 for brackets/colon/spaces
    #define MAX_DFL_LENGTH (MAX_PATH + 37)

    // So that it can be used as a callback if desired
    typedef VOID(CALLBACK *ERRORPROC)(DWORD, WCHAR *, INT, HANDLE, BOOL);

    /**
    * Logs an error message that occurred elsewhere in the program.
    * PARAMETERS:
    * dwError - The system error code to process.
    * wszFileName - The name of the file in which the error occurred (pass __FILEW__)
    * nLine - The line at which the error was detected (pass __LINE__)
    * hOutFile - A handle to an already open file for writing the error message to.
    * fRecoverable - If true, this error is recoverable; return to the calling code. If false, exit after logging the error.
    */
    VOID CALLBACK ErrorProc(
    DWORD dwError,
    WCHAR *wszFileName,
    INT nLine,
    HANDLE hOutFile,
    BOOL fRecoverable
    )
    FORMAT_MESSAGE_IGNORE_INSERTS,
    NULL,
    dwError,
    MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT),
    (LPVOID)&lpMsgBuf,
    0,
    NULL
    );

    GetLocalTime(&st);
    StringCchPrintfW(
    wszDateFileLine,
    MAX_DFL_LENGTH,
    L"[%.4hu-%.2hu-%.2huT%.2hu:%.2hu:%.2hu %s:%d] ",
    st.wYear,
    st.wMonth,
    st.wDay,
    st.wHour,
    st.wMinute,
    st.wSecond,
    wszFileName,
    nLine
    );

    SetFilePointer(hOutFile, 0, NULL, FILE_END);
    hr = StringCbLengthW(wszDateFileLine, (MAX_DFL_LENGTH) * sizeof(WCHAR), &uLen);
    if (SUCCEEDED(hr))

    WriteFile(hOutFile, wszDateFileLine, uLen, &dwWritten, NULL);


    hr = StringCbLengthW(lpMsgBuf, STRSAFE_MAX_CCH * sizeof(WCHAR), &uLen);
    if (SUCCEEDED(hr))

    // Length - 2 WCHARs to not write out the rn at the end of the error message.
    WriteFile(hOutFile, lpMsgBuf, uLen - (2 * sizeof(WCHAR)), &dwWritten, NULL);


    WriteFile(hOutFile, wRecovMsg[!!fRecoverable], (36 + (!!fRecoverable * 3)) * sizeof(WCHAR), &dwWritten, NULL);
    LocalFree((HLOCAL)lpMsgBuf);

    if (FALSE == fRecoverable)

    ExitProcess(dwError);




    While this historically worked well enough for my personal projects, I am wondering if there are any modifications I should make to the presentation or operation of this function before suggesting its addition to a larger Windows project with an entire team of developers.









    share









    $endgroup$














      0












      0








      0





      $begingroup$


      I have written the following function to be a general "error logging" solution for my Windows API projects. Basically, given a Windows system error code (a la GetLastError()), it will log the error message into a file:



      #include <Windows.h>
      #include <strsafe.h>

      // MAX_PATH for file name, 12 for max signed int in base 10 (-2147483648), 20 for datetime string, 5 for brackets/colon/spaces
      #define MAX_DFL_LENGTH (MAX_PATH + 37)

      // So that it can be used as a callback if desired
      typedef VOID(CALLBACK *ERRORPROC)(DWORD, WCHAR *, INT, HANDLE, BOOL);

      /**
      * Logs an error message that occurred elsewhere in the program.
      * PARAMETERS:
      * dwError - The system error code to process.
      * wszFileName - The name of the file in which the error occurred (pass __FILEW__)
      * nLine - The line at which the error was detected (pass __LINE__)
      * hOutFile - A handle to an already open file for writing the error message to.
      * fRecoverable - If true, this error is recoverable; return to the calling code. If false, exit after logging the error.
      */
      VOID CALLBACK ErrorProc(
      DWORD dwError,
      WCHAR *wszFileName,
      INT nLine,
      HANDLE hOutFile,
      BOOL fRecoverable
      )
      FORMAT_MESSAGE_IGNORE_INSERTS,
      NULL,
      dwError,
      MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT),
      (LPVOID)&lpMsgBuf,
      0,
      NULL
      );

      GetLocalTime(&st);
      StringCchPrintfW(
      wszDateFileLine,
      MAX_DFL_LENGTH,
      L"[%.4hu-%.2hu-%.2huT%.2hu:%.2hu:%.2hu %s:%d] ",
      st.wYear,
      st.wMonth,
      st.wDay,
      st.wHour,
      st.wMinute,
      st.wSecond,
      wszFileName,
      nLine
      );

      SetFilePointer(hOutFile, 0, NULL, FILE_END);
      hr = StringCbLengthW(wszDateFileLine, (MAX_DFL_LENGTH) * sizeof(WCHAR), &uLen);
      if (SUCCEEDED(hr))

      WriteFile(hOutFile, wszDateFileLine, uLen, &dwWritten, NULL);


      hr = StringCbLengthW(lpMsgBuf, STRSAFE_MAX_CCH * sizeof(WCHAR), &uLen);
      if (SUCCEEDED(hr))

      // Length - 2 WCHARs to not write out the rn at the end of the error message.
      WriteFile(hOutFile, lpMsgBuf, uLen - (2 * sizeof(WCHAR)), &dwWritten, NULL);


      WriteFile(hOutFile, wRecovMsg[!!fRecoverable], (36 + (!!fRecoverable * 3)) * sizeof(WCHAR), &dwWritten, NULL);
      LocalFree((HLOCAL)lpMsgBuf);

      if (FALSE == fRecoverable)

      ExitProcess(dwError);




      While this historically worked well enough for my personal projects, I am wondering if there are any modifications I should make to the presentation or operation of this function before suggesting its addition to a larger Windows project with an entire team of developers.









      share









      $endgroup$




      I have written the following function to be a general "error logging" solution for my Windows API projects. Basically, given a Windows system error code (a la GetLastError()), it will log the error message into a file:



      #include <Windows.h>
      #include <strsafe.h>

      // MAX_PATH for file name, 12 for max signed int in base 10 (-2147483648), 20 for datetime string, 5 for brackets/colon/spaces
      #define MAX_DFL_LENGTH (MAX_PATH + 37)

      // So that it can be used as a callback if desired
      typedef VOID(CALLBACK *ERRORPROC)(DWORD, WCHAR *, INT, HANDLE, BOOL);

      /**
      * Logs an error message that occurred elsewhere in the program.
      * PARAMETERS:
      * dwError - The system error code to process.
      * wszFileName - The name of the file in which the error occurred (pass __FILEW__)
      * nLine - The line at which the error was detected (pass __LINE__)
      * hOutFile - A handle to an already open file for writing the error message to.
      * fRecoverable - If true, this error is recoverable; return to the calling code. If false, exit after logging the error.
      */
      VOID CALLBACK ErrorProc(
      DWORD dwError,
      WCHAR *wszFileName,
      INT nLine,
      HANDLE hOutFile,
      BOOL fRecoverable
      )
      FORMAT_MESSAGE_IGNORE_INSERTS,
      NULL,
      dwError,
      MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT),
      (LPVOID)&lpMsgBuf,
      0,
      NULL
      );

      GetLocalTime(&st);
      StringCchPrintfW(
      wszDateFileLine,
      MAX_DFL_LENGTH,
      L"[%.4hu-%.2hu-%.2huT%.2hu:%.2hu:%.2hu %s:%d] ",
      st.wYear,
      st.wMonth,
      st.wDay,
      st.wHour,
      st.wMinute,
      st.wSecond,
      wszFileName,
      nLine
      );

      SetFilePointer(hOutFile, 0, NULL, FILE_END);
      hr = StringCbLengthW(wszDateFileLine, (MAX_DFL_LENGTH) * sizeof(WCHAR), &uLen);
      if (SUCCEEDED(hr))

      WriteFile(hOutFile, wszDateFileLine, uLen, &dwWritten, NULL);


      hr = StringCbLengthW(lpMsgBuf, STRSAFE_MAX_CCH * sizeof(WCHAR), &uLen);
      if (SUCCEEDED(hr))

      // Length - 2 WCHARs to not write out the rn at the end of the error message.
      WriteFile(hOutFile, lpMsgBuf, uLen - (2 * sizeof(WCHAR)), &dwWritten, NULL);


      WriteFile(hOutFile, wRecovMsg[!!fRecoverable], (36 + (!!fRecoverable * 3)) * sizeof(WCHAR), &dwWritten, NULL);
      LocalFree((HLOCAL)lpMsgBuf);

      if (FALSE == fRecoverable)

      ExitProcess(dwError);




      While this historically worked well enough for my personal projects, I am wondering if there are any modifications I should make to the presentation or operation of this function before suggesting its addition to a larger Windows project with an entire team of developers.







      c error-handling winapi





      share












      share










      share



      share










      asked 8 mins ago









      Govind ParmarGovind Parmar

      25729




      25729




















          0






          active

          oldest

          votes











          Your Answer





          StackExchange.ifUsing("editor", function ()
          return StackExchange.using("mathjaxEditing", function ()
          StackExchange.MarkdownEditor.creationCallbacks.add(function (editor, postfix)
          StackExchange.mathjaxEditing.prepareWmdForMathJax(editor, postfix, [["\$", "\$"]]);
          );
          );
          , "mathjax-editing");

          StackExchange.ifUsing("editor", function ()
          StackExchange.using("externalEditor", function ()
          StackExchange.using("snippets", function ()
          StackExchange.snippets.init();
          );
          );
          , "code-snippets");

          StackExchange.ready(function()
          var channelOptions =
          tags: "".split(" "),
          id: "196"
          ;
          initTagRenderer("".split(" "), "".split(" "), channelOptions);

          StackExchange.using("externalEditor", function()
          // Have to fire editor after snippets, if snippets enabled
          if (StackExchange.settings.snippets.snippetsEnabled)
          StackExchange.using("snippets", function()
          createEditor();
          );

          else
          createEditor();

          );

          function createEditor()
          StackExchange.prepareEditor(
          heartbeatType: 'answer',
          autoActivateHeartbeat: false,
          convertImagesToLinks: false,
          noModals: true,
          showLowRepImageUploadWarning: true,
          reputationToPostImages: null,
          bindNavPrevention: true,
          postfix: "",
          imageUploader:
          brandingHtml: "Powered by u003ca class="icon-imgur-white" href="https://imgur.com/"u003eu003c/au003e",
          contentPolicyHtml: "User contributions licensed under u003ca href="https://creativecommons.org/licenses/by-sa/3.0/"u003ecc by-sa 3.0 with attribution requiredu003c/au003e u003ca href="https://stackoverflow.com/legal/content-policy"u003e(content policy)u003c/au003e",
          allowUrls: true
          ,
          onDemand: true,
          discardSelector: ".discard-answer"
          ,immediatelyShowMarkdownHelp:true
          );



          );













          draft saved

          draft discarded


















          StackExchange.ready(
          function ()
          StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2fcodereview.stackexchange.com%2fquestions%2f215879%2ferror-handling-function-win32-c%23new-answer', 'question_page');

          );

          Post as a guest















          Required, but never shown

























          0






          active

          oldest

          votes








          0






          active

          oldest

          votes









          active

          oldest

          votes






          active

          oldest

          votes















          draft saved

          draft discarded
















































          Thanks for contributing an answer to Code Review Stack Exchange!


          • Please be sure to answer the question. Provide details and share your research!

          But avoid


          • Asking for help, clarification, or responding to other answers.

          • Making statements based on opinion; back them up with references or personal experience.

          Use MathJax to format equations. MathJax reference.


          To learn more, see our tips on writing great answers.




          draft saved


          draft discarded














          StackExchange.ready(
          function ()
          StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2fcodereview.stackexchange.com%2fquestions%2f215879%2ferror-handling-function-win32-c%23new-answer', 'question_page');

          );

          Post as a guest















          Required, but never shown





















































          Required, but never shown














          Required, but never shown












          Required, but never shown







          Required, but never shown

































          Required, but never shown














          Required, but never shown












          Required, but never shown







          Required, but never shown







          Popular posts from this blog

          名間水力發電廠 目录 沿革 設施 鄰近設施 註釋 外部連結 导航菜单23°50′10″N 120°42′41″E / 23.83611°N 120.71139°E / 23.83611; 120.7113923°50′10″N 120°42′41″E / 23.83611°N 120.71139°E / 23.83611; 120.71139計畫概要原始内容臺灣第一座BOT 模式開發的水力發電廠-名間水力電廠名間水力發電廠 水利署首件BOT案原始内容《小檔案》名間電廠 首座BOT水力發電廠原始内容名間電廠BOT - 經濟部水利署中區水資源局

          格濟夫卡 參考資料 导航菜单51°3′40″N 34°2′21″E / 51.06111°N 34.03917°E / 51.06111; 34.03917ГезівкаПогода в селі 编辑或修订