Как правильно использовать FormatMessage () в C ++?

Question

Без

• MFC
• АТЛ

Как я могу использовать FormatMessage(), чтобы получить текст ошибки для HRESULT?

 HRESULT hresult = application.CreateInstance("Excel.Application");

 if (FAILED(hresult))
 {
     // what should i put here to obtain a human-readable
     // description of the error?
     exit (hresult);
 }

Answer 1

Вот правильный способ получить сообщение об ошибке из системы для HRESULT (в данном случае с именем hresult, или вы можете заменить его на GetLastError()):

LPTSTR errorText = NULL;

FormatMessage(
   // use system message tables to retrieve error text
   FORMAT_MESSAGE_FROM_SYSTEM
   // allocate buffer on local heap for error text
   |FORMAT_MESSAGE_ALLOCATE_BUFFER
   // Important! will fail otherwise, since we're not 
   // (and CANNOT) pass insertion parameters
   |FORMAT_MESSAGE_IGNORE_INSERTS,  
   NULL,    // unused with FORMAT_MESSAGE_FROM_SYSTEM
   hresult,
   MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT),
   (LPTSTR)&errorText,  // output 
   0, // minimum size for output buffer
   NULL);   // arguments - see note 

if ( NULL != errorText )
{
   // ... do something with the string `errorText` - log it, display it to the user, etc.

   // release memory allocated by FormatMessage()
   LocalFree(errorText);
   errorText = NULL;
}

Ключевым отличием этого ответа от Дэвида Ханака является использование флага FORMAT_MESSAGE_IGNORE_INSERTS. В MSDN немного неясно, как использовать вставки, но Рэймонд Чен отмечает, что вы никогда не должны использовать их при получении системного сообщения, поскольку у вас нет способа узнать, какие вставки ожидает система.

FWIW, если вы используете Visual C ++, вы можете немного упростить свою жизнь с помощью класса _com_error:

{
   _com_error error(hresult);
   LPCTSTR errorText = error.ErrorMessage();

   // do something with the error...

   //automatic cleanup when error goes out of scope
}

Насколько я знаю, не является частью MFC или ATL напрямую.

Answer 2

Имейте в виду, что вы не можете делать следующее:

{
   LPCTSTR errorText = _com_error(hresult).ErrorMessage();

   // do something with the error...

   //automatic cleanup when error goes out of scope
}

Поскольку класс создается и уничтожается в стеке, оставляя errorText, чтобы указать на недопустимое местоположение. В большинстве случаев это место будет по-прежнему содержать строку ошибки, но эта вероятность быстро уменьшается при написании многопоточных приложений.

Итак всегда сделайте это следующим образом, как ответил Shog9 выше:

{
   _com_error error(hresult);
   LPCTSTR errorText = error.ErrorMessage();

   // do something with the error...

   //automatic cleanup when error goes out of scope
}

Answer 3

Попробуйте это:

void PrintLastError (const char *msg /* = "Error occurred" */) {
        DWORD errCode = GetLastError();
        char *err;
        if (!FormatMessage(FORMAT_MESSAGE_ALLOCATE_BUFFER | FORMAT_MESSAGE_FROM_SYSTEM,
                           NULL,
                           errCode,
                           MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT), // default language
                           (LPTSTR) &err,
                           0,
                           NULL))
            return;

        static char buffer[1024];
        _snprintf(buffer, sizeof(buffer), "ERROR: %s: %s\n", msg, err);
        OutputDebugString(buffer); // or otherwise log it
        LocalFree(err);
}

Answer 4

Это скорее дополнение к большинству ответов, но вместо использования LocalFree(errorText) используйте функцию HeapFree:

::HeapFree(::GetProcessHeap(), NULL, errorText);

С сайта MSDN :

Windows 10 :
LocalFree отсутствует в современном SDK, поэтому его нельзя использовать для освобождения буфера результатов. Вместо этого используйте HeapFree (GetProcessHeap (), allocMessage). В этом случае это аналогично вызову LocalFree для памяти.

Обновление
Я обнаружил, что LocalFree находится в версии 10.0.10240.0 SDK (строка 1108 в WinBase.h). Тем не менее, предупреждение по-прежнему существует в ссылке выше.

#pragma region Desktop Family or OneCore Family
#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM)

WINBASEAPI
_Success_(return==0)
_Ret_maybenull_
HLOCAL
WINAPI
LocalFree(
    _Frees_ptr_opt_ HLOCAL hMem
    );

#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) */
#pragma endregion

Обновление 2
Я бы также предложил использовать флаг FORMAT_MESSAGE_MAX_WIDTH_MASK для исправления разрывов строк в системных сообщениях.

С сайта MSDN :

FORMAT_MESSAGE_MAX_WIDTH_MASK
Функция игнорирует обычные разрывы строк в тексте определения сообщения. Функция сохраняет жестко закодированные разрывы строк в тексте определения сообщения в выходном буфере. Функция не генерирует новых разрывов строк.

Обновление 3
Кажется, есть 2 конкретных кода системных ошибок, которые не возвращают полное сообщение, используя рекомендуемый подход:

Почему FormatMessage создает только частичные сообщения для системных ошибок ERROR_SYSTEM_PROCESS_TERMINATED и ERROR_UNHANDLED_EXCEPTION?

Answer 5

Вот версия функции Дэвида, которая обрабатывает Unicode

void HandleLastError(const TCHAR *msg /* = "Error occured" */) {
    DWORD errCode = GetLastError();
    TCHAR *err;
    if (!FormatMessage(FORMAT_MESSAGE_ALLOCATE_BUFFER | FORMAT_MESSAGE_FROM_SYSTEM,
                       NULL,
                       errCode,
                       MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT), // default language
                       (LPTSTR) &err,
                       0,
                       NULL))
        return;

    //TRACE("ERROR: %s: %s", msg, err);
    TCHAR buffer[1024];
    _sntprintf_s(buffer, sizeof(buffer), _T("ERROR: %s: %s\n"), msg, err);
    OutputDebugString(buffer);
    LocalFree(err);

}

Answer 6

Как указано в других ответах:

• FormatMessage принимает DWORD результат, а не HRESULT (обычно GetLastError()).
• LocalFree требуется для освобождения памяти, выделенной FormatMessage

Я взял вышеупомянутые пункты и добавил еще несколько к моему ответу:

• Оберните FormatMessage в классе для автоматического выделения и освобождения памяти при необходимости
• Используйте перегрузку оператора (например, operator LPTSTR() const { return ...; }, чтобы ваш класс можно было использовать как строку

class CFormatMessage
{
public:
    CFormatMessage(DWORD dwError) : m_ErrorText(NULL) { Assign(dwError); }
    ~CFormatMessage() { Clear(); }
    void Clear() { if (m_ErrorText != NULL) { LocalFree(m_ErrorText); m_ErrorText = NULL; } }
    void Assign(DWORD dwError) {
        Clear();
        FormatMessage(
            FORMAT_MESSAGE_FROM_SYSTEM | FORMAT_MESSAGE_ALLOCATE_BUFFER | FORMAT_MESSAGE_IGNORE_INSERTS,
            NULL,
            dwError,
            MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT),
            (LPTSTR)&m_ErrorText,
            0,
            NULL);
    }
    LPTSTR ErrorText() const { return m_ErrorText; }
    operator LPTSTR() const { return ErrorText(); }
protected:
    LPTSTR m_ErrorText;
};

Найдите более полную версию приведенного выше кода здесь: https://github.com/stephenquan/FormatMessage

С вышеприведенным классом использование просто:

    std::wcout << (LPTSTR) CFormatMessage(GetLastError()) << L"\n";

Answer 7

Начиная с c ++ 11, вы можете использовать стандартную библиотеку вместо FormatMessage:

#include <system_error>

std::string message = std::system_category().message(hr)

Answer 8

Приведенный ниже код является кодом C ++, который я написал в отличие от Microsoft ErrorExit () , но немного изменен, чтобы избежать всех макросов и использовать юникод Идея здесь состоит в том, чтобы избежать ненужных приведений и mallocs. Я не мог избежать всех бросков Си, но это лучшее, что я мог собрать. Относится к FormatMessageW (), который требует, чтобы указатель был выделен функцией форматирования и идентификатором ошибки из GetLastError (). Указатель после static_cast может использоваться как обычный указатель wchar_t.

#include <string>
#include <windows.h>

void __declspec(noreturn) error_exit(const std::wstring FunctionName)
{
    // Retrieve the system error message for the last-error code
    const DWORD ERROR_ID = GetLastError();
    void* MsgBuffer = nullptr;
    LCID lcid;
    GetLocaleInfoEx(L"en-US", LOCALE_RETURN_NUMBER | LOCALE_ILANGUAGE, (wchar_t*)&lcid, sizeof(lcid));

    //get error message and attach it to Msgbuffer
    FormatMessageW(
        FORMAT_MESSAGE_ALLOCATE_BUFFER | FORMAT_MESSAGE_FROM_SYSTEM | FORMAT_MESSAGE_IGNORE_INSERTS,
        NULL, ERROR_ID, lcid, (wchar_t*)&MsgBuffer, 0, NULL);
    //concatonate string to DisplayBuffer
    const std::wstring DisplayBuffer = FunctionName + L" failed with error " + std::to_wstring(ERROR_ID) + L": " + static_cast<wchar_t*>(MsgBuffer);

    // Display the error message and exit the process
    MessageBoxExW(NULL, DisplayBuffer.c_str(), L"Error", MB_ICONERROR | MB_OK, static_cast<WORD>(lcid));

    ExitProcess(ERROR_ID);
}