FormatMessage函数

在开发软件的过程里，经常要做的工作就是调试程序，许多问题的出现，不但是逻辑的问题，还有可能是对API的不熟悉，或者某种条件下调用API会出错的。那么这些出错的原因是什么呢？通常只获取到错误码，也就是通过函数GetLastError得到。当然可以根据这个错误码去查找MSDN就可以知道出错的原因，但有时在客户那里并没有MSDN，那么就需要把调用API函数出错的信息显示出来，或者写到LOG里去。这时就需要调用函数FormatMessage把出错码详细原因显示出来。

　　函数FormatMessage声明如下：

WINBASEAPI DWORD WINAPI FormatMessageA( 　　　　DWORD　dwFlags, 　　　　LPCVOID　lpSource, 　　　　DWORD　dwMessageId, 　　　　DWORD　dwLanguageId, 　　　　LPSTR　lpBuffer, 　　　　DWORD　nSize, 　　　　va_list　*Arguments 　　　　); WINBASEAPI DWORD WINAPI FormatMessageW( 　　　　DWORD　dwFlags, 　　　　LPCVOID　lpSource, 　　　　DWORD　dwMessageId, 　　　　DWORD　dwLanguageId, 　　　　LPWSTR　lpBuffer, 　　　　DWORD　nSize, 　　　　va_list　*Arguments 　　　　); #ifdef　UNICODE #define　FormatMessage　FormatMessageW #else #define　FormatMessage　FormatMessageA #endif　//　!UNICODE

　　调用函数的例子如下：

#001　//系统错误信息提示。 #002　　//蔡军生　2007/11/28　qq:9073204　深圳 #003　　void　TestErrorInfo(void) #004　　{ #005　　　　　　　　　//进行出错。 #006　　　　　　　　　if　(!CreateDirectory(_T("c:\\"),0)) #007　　　　　　　　　{ #008　　　　　　　　　　　　　　　TCHAR　szBuf[128]; #009　　　　　　　　　　　　　　　LPVOID　lpMsgBuf; #010　　　　　　　　　　　　　　　DWORD　dw　=　GetLastError(); #011　 #012　　　　　　　　　　　　　　FormatMessage( #013　　　　　　　　　　　　　　　　　　　FORMAT_MESSAGE_ALLOCATE_BUFFER　| #014　　　　　　　　　　　　　　　　　　　FORMAT_MESSAGE_FROM_SYSTEM, #015　　　　　　　　　　　　　　　　　　　NULL, #016　　　　　　　　　　　　　　　　　　　dw, #017　　　　　　　　　　　　　　　　　　　MAKELANGID(LANG_NEUTRAL,　SUBLANG_DEFAULT), #018　　　　　　　　　　　　　　　　　　　(LPTSTR)　&lpMsgBuf, #019　　　　　　　　　　　　　　　　　　　0,　NULL　); #020　 #021　　　　　　　　　　　　　　　　wsprintf(szBuf, #022　　　　　　　　　　　　　　　　　　　　_T("%s　出错信息　(出错码＝%d):　%s"), #023　　　　　　　　　　　　　　　　　　　　_T("CreateDirectory"),　dw,　lpMsgBuf); #024　 #025　　　　　　　　　　　　　　　LocalFree(lpMsgBuf); #026　 #027　　　　　　　　　　　　　　　//输出提示。 #028　　　　　　　　　　　　　　　OutputDebugString(szBuf); #029　　　　　　　　　} #030　　　　　　　　 #031　　}

　　调用后输出下面的提示信息：

　　CreateDirectory 出错信息 (出错码＝5): 拒绝访问。

　　函数FormatMessage声明如下：

　　调用函数的例子如下：

　　调用后输出下面的提示信息：

　　CreateDirectory 出错信息 (出错码＝5): 拒绝访问。

根据一个错误码返回一个错误讯息

DWORD FormatMessage(
    DWORD dwFlags,
    LPCVOID lpSource,
    DWORD dwMessageId,
    DWORD dwLanguageId,
    LPTSTR lpBuffer,
    DWORD nSize,
    va_list* Arguments
    );

dwFlags:
# FORMAT_MESSAGE_ALLOCATE_BUFFER // 此函数会分配内存以包含描述字串。
# FORMAT_MESSAGE_FROM_SYSTEM, // 在系统的id映射表中寻找描述字串
# FORMAT_MESSAGE_FROM_HMODULE // 在其他资源模块中寻找描述字串
# FORMAT_MESSAGE_FROM_STRING   // 消息ID是个字串，不是个DWORD
通常为：FORMAT_MESSAGE_ALLOCATE_BUFFER | FORMAT_MESSAGE_FROM_SYSTEM

lpSource:
# 指定了FORMAT_MESSAGE_FROM_HMODULE的话，此参数表示模块的HANDLE
# 指定了FORMAT_MESSAGE_FROM_STRING的话，此参数表示id字串
通常为：NULL

dwMessageId:
消息ID;如果指定FORMAT_MESSAGE_FROM_STRING，将被忽略。

dwLanguageId:
消息描述所用的语言
通常为：0表示自动选择

lpBuffer:
#如果未指定FORMAT_MESSAGE_ALLOCATE_BUFFER，则为自己提供的缓冲区
#否则为系统LocalAlloc分配，需要被用户LocalFree

nSize:
#如果未指定FORMAT_MESSAGE_ALLOCATE_BUFFER，则为自己提供的缓冲区大小
#否则为系统LocalAlloc分配之最小缓冲区大小

Arguments:
通常不使用

下面是个例子：

TCHAR* buffer;
DWORD error = ERROR_DS_OBJ_STRING_NAME_EXISTS;
::FormatMessage(
    FORMAT_MESSAGE_ALLOCATE_BUFFER | FORMAT_MESSAGE_FROM_SYSTEM,
    NULL,
    error,
    0,
    ( LPTSTR )&buffer,
    0,
    NULL );
::MessageBox( NULL, buffer, NULL, 0 );
LocalFree( buffer );

公告

FormatMessage函数