int log_hresult_fill_property()

in v2/src/log_hresult.c [26:118]

• 66 lines of code
• 9 McCabe index (conditional complexity)

int log_hresult_fill_property(void* buffer, HRESULT hresult)
{
    if (buffer == NULL)
    {
        /* Codes_SRS_LOG_HRESULT_01_001: [ If buffer is NULL, log_hresult_fill_property shall return 512 to indicate how many bytes shall be reserved for the HRESULT string formatted version. ] */
    }
    else
    {
        /*see if the "system" can provide the code*/
        /* Codes_SRS_LOG_HRESULT_01_002: [ log_hresult_fill_property shall call FormatMessageA_no_newline with FORMAT_MESSAGE_FROM_SYSTEM | FORMAT_MESSAGE_IGNORE_INSERTS, hresult, 0 as language Id, buffer as buffer to place the output and 512 as buffer size. ] */
        if (FormatMessageA_no_newline(
            FORMAT_MESSAGE_FROM_SYSTEM | FORMAT_MESSAGE_IGNORE_INSERTS,
            NULL,
            hresult,
            0, /*if you pass in zero, FormatMessage looks for a message for LANGIDs in the following order...*/
            buffer, MESSAGE_BUFFER_SIZE, NULL) != 0)
        {
            /*success, SYSTEM was able to find the message*/
            /*return as is*/
        }
        else
        {
            /* Codes_SRS_LOG_HRESULT_01_004: [ If FormatMessageA_no_newline returns 0, log_hresult_fill_property attempt to look up the formatted string from the loaded modules: ] */

            /* Codes_SRS_LOG_HRESULT_01_005: [ log_hresult_fill_property shall get the current process handle by calling GetCurrentProcess. ] */
            HANDLE currentProcess = GetCurrentProcess();
            /*apparently this cannot fail and returns somewhat of a "pseudo handle"*/

            HMODULE module_handles[N_MAX_MODULES];
            DWORD enumModulesUsedBytes;

            /* Codes_SRS_LOG_HRESULT_01_006: [ log_hresult_fill_property shall call EnumProcessModules and obtain the information about 10 modules. ] */
            if (EnumProcessModules(currentProcess, module_handles, sizeof(module_handles), &enumModulesUsedBytes) == 0)
            {
                /* Codes_SRS_LOG_HRESULT_01_009: [ If EnumProcessModules fails, log_hresult_fill_property shall place in buffer a string indicating what failed, the last error and unknown HRESULT 0x%x, where %x is the hresult value. ] */
                if (snprintf(buffer, MESSAGE_BUFFER_SIZE, "failure in EnumProcessModules, LE=%lu, unknown HRESULT 0x%x", GetLastError(), hresult) < 0)
                {
                    /* Codes_SRS_LOG_HRESULT_01_008: [ If printing the unknown HRESULT 0x%x string fails, log_hresult_fill_property shall place in buffer the string snprintf failed. ] */
                    (void)memcpy(buffer, snprintf_failure_message, sizeof(snprintf_failure_message));
                }
                else
                {
                    // leave as is
                }
            }
            else
            {
                size_t iModule;

                /* Codes_SRS_LOG_HRESULT_01_010: [ For each module: ] */
                for (iModule = 0; iModule < (enumModulesUsedBytes / sizeof(HMODULE)); iModule++)
                {
                    /*see if this module */
                    /* Codes_SRS_LOG_HRESULT_01_011: [ log_hresult_fill_property shall call FormatMessageA with FORMAT_MESSAGE_FROM_HMODULE | FORMAT_MESSAGE_IGNORE_INSERTS, the module handle, the hresult value, 0 as language Id, buffer as buffer to place the output and 512 as buffer size. ] */
                    if (FormatMessageA_no_newline(
                        FORMAT_MESSAGE_FROM_HMODULE | FORMAT_MESSAGE_IGNORE_INSERTS,
                        module_handles[iModule],
                        hresult,
                        0,
                        buffer, MESSAGE_BUFFER_SIZE, NULL) != 0)
                    {
                        break;
                    }
                    else
                    {
                        /*this module does not have it...*/
                    }
                }

                if (iModule == (enumModulesUsedBytes / sizeof(HMODULE)))
                {
                    /* Codes_SRS_LOG_HRESULT_01_007: [ If no module has the formatted message, log_hresult_fill_property shall place in buffer the string unknown HRESULT 0x%x, where %x is the hresult value. ] */
                    if (snprintf(buffer, MESSAGE_BUFFER_SIZE, "unknown HRESULT 0x%x", hresult) < 0)
                    {
                        /* Codes_SRS_LOG_HRESULT_01_008: [ If printing the unknown HRESULT 0x%x string fails, log_hresult_fill_property shall place in buffer the string snprintf failed. ] */
                        (void)memcpy(buffer, snprintf_failure_message, sizeof(snprintf_failure_message));
                    }
                    else
                    {
                        // leave as is
                    }
                }
                else
                {
                    // all good
                }
            }
        }
    }

    /* Codes_SRS_LOG_HRESULT_01_003: [ log_lasterror_fill_property shall return 512. ] */
    return MESSAGE_BUFFER_SIZE;
}