如何在使用FormatMessage(FORMAT_MESSAGE_FROM_SYSTEM)时避免FORMAT_MESSAGE_ALLOCATE_BUFFER？

在Win32开发中，我们经常需要用FormatMessage()配合FORMAT_MESSAGE_FROM_SYSTEM标志，结合GetLastError()返回的错误码生成可读的系统错误描述。这类场景下，优先使用栈分配缓冲区能减少堆内存操作的开销与复杂度，但FormatMessage()并不像GetTempPath2()这类API支持预查询缓冲区大小——如果传入NULL缓冲区且不指定FORMAT_MESSAGE_ALLOCATE_BUFFER，调用会直接失败，无法获取所需的缓冲区长度。

可行的实现思路 #

我们可以采用「栈分配优先，堆分配兜底」的方案：

1. 栈分配初始缓冲区：在栈上声明一个足够大的缓冲区，比如wchar_t szErrMsg[8196]（ANSI版用char）。这个尺寸的选择基于实践经验：系统错误消息（包括德语等比英语冗长的语言版本）几乎不会超过8196字符的长度，完全能覆盖绝大多数场景。
2. 尝试栈缓冲区格式化：调用FormatMessage()，传入栈缓冲区、缓冲区长度，同时指定FORMAT_MESSAGE_FROM_SYSTEM | FORMAT_MESSAGE_IGNORE_INSERTS | FORMAT_MESSAGE_MAX_WIDTH_MASK标志（FORMAT_MESSAGE_IGNORE_INSERTS用于避免因未传入占位符参数导致的格式化失败，FORMAT_MESSAGE_MAX_WIDTH_MASK则让消息自动换行适配常规显示）。
3. 堆分配兜底：如果调用失败且GetLastError()返回ERROR_INSUFFICIENT_BUFFER，再改用FORMAT_MESSAGE_ALLOCATE_BUFFER标志让系统自动分配堆缓冲区，使用完成后必须调用LocalFree()释放内存。

代码示例 #

DWORD dwLastError = GetLastError();
wchar_t szStackErrBuf[8196] = { 0 };
DWORD dwWritten = FormatMessageW(
    FORMAT_MESSAGE_FROM_SYSTEM | FORMAT_MESSAGE_IGNORE_INSERTS | FORMAT_MESSAGE_MAX_WIDTH_MASK,
    NULL,
    dwLastError,
    MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT),
    szStackErrBuf,
    _countof(szStackErrBuf),
    NULL
);

if (0 == dwWritten && ERROR_INSUFFICIENT_BUFFER == GetLastError())
{
    PWSTR pHeapErrMsg = NULL;
    dwWritten = FormatMessageW(
        FORMAT_MESSAGE_FROM_SYSTEM | FORMAT_MESSAGE_IGNORE_INSERTS | FORMAT_MESSAGE_MAX_WIDTH_MASK | FORMAT_MESSAGE_ALLOCATE_BUFFER,
        NULL,
        dwLastError,
        MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT),
        (LPWSTR)&pHeapErrMsg,
        0,
        NULL
    );

    if (dwWritten > 0)
    {
        // 处理堆分配的错误消息
        LocalFree(pHeapErrMsg);
    }
}
else if (dwWritten > 0)
{
    // 处理栈分配的错误消息
}

注意事项 #

• 虽然没有官方文档明确系统错误消息的最大长度，但8196字符的栈缓冲区在实际开发中足够可靠，几乎不会触发堆分配的兜底逻辑。
• 务必区分FormatMessageA()和FormatMessageW()，对应使用char或wchar_t类型的缓冲区，避免编码不匹配问题。

内容的提问来源于stack exchange，提问作者kevinarpe