-
DWORD WINAPI FormatMessage (
-
DWORD dwFlags, // source and processing options
-
LPCVOID lpSource, // message source
-
DWORD dwMessageId, // message identifier
-
DWORD dwLanguageId, // language identifier
-
LPTSTR lpBuffer, // message buffer
-
DWORD nSize, // maximum size of message buffer
-
va_list *Arguments // array of message inserts
- );
dwFlags的低位值指定了函数如何处理输出缓冲区处理行转换,也可以指定格式化输出字符串输出行的最大宽度。
标志 | 标志说明 |
---|---|
FORMAT_MESSAGE_ALLOCATE_BUFFER
|
函数会分配一个足够大的缓冲区保存格式化消息,并且通过lpBuffer指向该
地址。
|
FORMAT_MESSAGE_ARGUMENT_ARRAY
|
Arguments参数不是指向va_list结构体,但是是一个指向保存参数的数据。
|
FORMAT_MESSAGE_FROM_HMODULE
|
lpSource参数是需要去搜索的一个包含消息表的模块线程。如果lpSource
是NULL,当前进程的应用图像会被搜索,这个标志不能同FORMAT_ME
SSAGE_FROM_STRING使用。
|
FORMAT_MESSAGE_FROM_STRING
|
lpSource参数是一个指向以NULL结尾的字符串,字符串包含一个消息定义,
这个消息定义可以包含插入序列。此标志最好不要和FORMAT_MESSAGE_F
ROM_HMODULE或者FORMAT_MESSAGE_FROM_SYSTEM使用
|
FORMAT_MESSAGE_FROM_SYSTEM
0x00001000
|
函数会为了请求的信息而搜索系统的消息表资源。如果标志同时也指定了
FORMAT_MESSAGE_FROM_HMODULE,那么函数会先在lpSource指定
的模块中搜索请求的消息,如果搜索不到,就去搜索系统消息表资源。此
标志不能与FORMAT_MESSAGE_FROM_STRING使用。
|
FORMAT_MESSAGE_IGNORE_INSERTS
|
消息定义中的插入序列会被一直忽略和跳过直到输出缓冲区不改变,并且
Arguments会被忽略。
|
开始在上面说了dwflags参数低位值作用,你可以使用以下值来设置低位值。
Value |
Meaning |
0 |
将不会有输出行宽度限制。
|
FORMAT_MESSAGE_MAX_WIDTH_MASK |
lpSource:
这个值是消息表资源来自哪里,这个值依靠dwFlags,详细请看FORMAT_MESSAGE_FROM_HMODULE和FORMAT_MESSAGE_FROM_STRING,如果这两个标示符都没设置,那么lpSource将会被忽略。
dwMessageId :
所需格式化消息的标识符。当dwFlags设置了FORMAT_MESSAGE_FROM_STRING,这个参数将会被忽略。
dwLanguageId:
格式化消息语言标识符。
lpBuffer:
一个缓冲区指针来接受格式化后的消息。当dwFlags包括了FORMAT_MESSAGE_ALLOCATE_BUFFER标志符,这个函数将会使用LocalAlloc函数分配一块缓冲区,lpBuffer需要接受一个地址来使用这个缓冲区。(这里要注意传参一定要传地址)。
nSize:
如果FORMAT_MESSAGE_ALLOCATE_BUFFER没有设置,那么这个参数指定了输出缓冲区的消息,以TCHARs为单位。如果FORMAT_MESSAGE_ALLOCATE_BUFFER设置了,这个参数设置以TCHARs为单位的输出缓冲区的最小值。这个输出缓冲区不能大于64KB。
Arguments:
一个数组中的值在格式化消息中作为插入值,根据消息文本的格式里面的内容(详见mc.exe使用),可以知道%n[!format_specifier!]为这个参数的指定形式。
例一:
使用系统的消息资源来报错,这也是这个函数最有用的地方。
点击(此处)折叠或打开
-
#include <windows.h>
-
#include <strsafe.h>
-
-
void ErrorExit(LPTSTR lpszFunction)
-
{
-
// Retrieve the system error message for the last-error code
-
-
LPVOID lpMsgBuf;
-
LPVOID lpDisplayBuf;
-
DWORD dw = GetLastError();
-
-
FormatMessage(
-
FORMAT_MESSAGE_ALLOCATE_BUFFER |
-
FORMAT_MESSAGE_FROM_SYSTEM |
-
FORMAT_MESSAGE_IGNORE_INSERTS,
-
NULL,
-
dw,
-
MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT),
-
(LPTSTR) &lpMsgBuf,
-
0, NULL );
-
-
// Display the error message and exit the process
-
-
lpDisplayBuf = (LPVOID)LocalAlloc(LMEM_ZEROINIT,
-
(lstrlen((LPCTSTR)lpMsgBuf)+lstrlen((LPCTSTR)lpszFunction)+40)*sizeof(TCHAR));
-
StringCchPrintf((LPTSTR)lpDisplayBuf,
-
LocalSize(lpDisplayBuf),
-
TEXT("%s failed with error %d: %s"),
-
lpszFunction, dw, lpMsgBuf);
-
MessageBox(NULL, (LPCTSTR)lpDisplayBuf, TEXT("Error"), MB_OK);
-
-
LocalFree(lpMsgBuf);
-
LocalFree(lpDisplayBuf);
-
ExitProcess(dw);
-
}
-
-
void main()
-
{
-
// Generate an error
-
-
if(!GetProcessId(NULL))
-
ErrorExit(TEXT("GetProcessId"));
- }
我们可以看到函数选项dwFlags
分别为FORMAT_MESSAGE_ALLOCATE_BUFFER由函数分配输出缓冲区,
FORMAT_MESSAGE_FROM_SYSTEM表示程序将会在系统消息表资源中搜索所需消息,
FORMAT_MESSAGE_IGNORE_INSERTS程序将会忽略搜索到消息中的插入序列。
lpSource值为NULL,并没有模块值和字符串直接传入所以为NULL,详细看以上各参数解析。
dwMessageId为dw,即GetLastError的返回值。就是消息资源的ID号。
dwLanguageId 设置为本地默认
lpBuffer 输出缓冲区这里注意& 为什么要&呢? 因为 LPVOID lpMsgBuf只是一个指针对象,那么要必须要把它的地址传给lpBuffer参数。
剩下两个参数可以上面参数的详解。
最后注意一点:由于lpBuffer这个参数的值是FormatMessage函数动态分配的缓冲区,所以在不使用的时候要LocalFree.
例二:
格式化模块中的消息资源,这里加载的模块之中要有消息资源,如果FormatMessage函数中传递了FORMAT_MESSAGE_FROM_SYSTEM,如果消息模块中没有我们所需的资源,那么将会在系统中寻找;如果没有 FORMAT_MESSAGE_FROM_SYSTEM,而且消息模块中没有我们所需资源,函数调用失败。
点击(此处)折叠或打开
-
#include <windows.h>
-
#include <stdio.h>
-
-
#include <lmerr.h>
-
-
void
-
DisplayErrorText(
-
DWORD dwLastError
-
);
-
-
#define RTN_OK 0
-
#define RTN_USAGE 1
-
#define RTN_ERROR 13
-
-
int
-
__cdecl
-
main(
-
int argc,
-
char *argv[]
-
)
-
{
-
if(argc != 2) {
-
fprintf(stderr,"Usage: %s
\n" , argv[0]);
-
return RTN_USAGE;
-
}
-
-
DisplayErrorText( atoi(argv[1]) );
-
-
return RTN_OK;
-
}
-
-
void
-
DisplayErrorText(
-
DWORD dwLastError
-
)
-
{
-
HMODULE hModule = NULL; // default to system source
-
LPSTR MessageBuffer;
-
DWORD dwBufferLength;
-
-
DWORD dwFormatFlags = FORMAT_MESSAGE_ALLOCATE_BUFFER |
-
FORMAT_MESSAGE_IGNORE_INSERTS |
-
FORMAT_MESSAGE_FROM_SYSTEM ;
-
-
//
-
// If dwLastError is in the network range,
-
// load the message source.
-
//
-
-
if(dwLastError >= NERR_BASE && dwLastError <= MAX_NERR) {
-
hModule = LoadLibraryEx(
-
TEXT("netmsg.dll"),
-
NULL,
-
LOAD_LIBRARY_AS_DATAFILE
-
);
-
-
if(hModule != NULL)
-
dwFormatFlags |= FORMAT_MESSAGE_FROM_HMODULE;
-
}
-
-
//
-
// Call FormatMessage() to allow for message
-
// text to be acquired from the system
-
// or from the supplied module handle.
-
//
-
-
if(dwBufferLength = FormatMessageA(
-
dwFormatFlags,
-
hModule, // module to get message from (NULL == system)
-
dwLastError,
-
MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT), // default language
-
(LPSTR) &MessageBuffer,
-
0,
-
NULL
-
))
-
{
-
DWORD dwBytesWritten;
-
-
//
-
// Output message string on stderr.
-
//
-
WriteFile(
-
GetStdHandle(STD_ERROR_HANDLE),
-
MessageBuffer,
-
dwBufferLength,
-
&dwBytesWritten,
-
NULL
-
);
-
-
//
-
// Free the buffer allocated by the system.
-
//
-
LocalFree(MessageBuffer);
-
}
-
-
//
-
// If we loaded a message source, unload it.
-
//
-
if(hModule != NULL)
-
FreeLibrary(hModule);
- }
之前两个例子都是经常使用的,那么FormatMessage之中还有个参数我们没有用过的,Arguments,那么我们在什么情况下使用呢?
我们前面已经详细解释了各个参数详细意义。我们先来看msdn两个有关使用这个值的例子:
点击(此处)折叠或打开
-
#ifndef UNICODE
-
#define UNICODE
-
#endif
-
-
#include <windows.h>
-
#include <stdio.h>
-
-
void main(void)
-
{
-
LPWSTR pMessage = L"%1!*.*s! %4 %5!*s!";
-
DWORD_PTR pArgs[] = { (DWORD_PTR)4, (DWORD_PTR)2, (DWORD_PTR)L"Bill", // % refers back to the first insertion string in pMessage
-
(DWORD_PTR)L"Bob", // %4 refers back to the second insertion string in pMessage
-
(DWORD_PTR)6, (DWORD_PTR)L"Bill" }; // % refers back to the third insertion string in pMessage
-
const DWORD size = 100+1;
-
WCHAR buffer[size];
-
-
-
if (!FormatMessage(FORMAT_MESSAGE_FROM_STRING | FORMAT_MESSAGE_ARGUMENT_ARRAY,
-
pMessage,
-
0,
-
0,
-
buffer,
-
size,
-
(va_list*)pArgs))
-
{
-
wprintf(L"Format message failed with 0x%x\n", GetLastError());
-
return;
-
}
-
-
// Buffer contains " Bi Bob Bill".
-
wprintf(L"Formatted message: %s\n", buffer);
- }
根据msdn中对Arguments参数的解释,这里插入序列遵循%n[!format_specifier!]
这个格式,如果format_specifer不清楚可以查阅printf输出格式。
的意义如下:
%1!*.*s! 表示为 %1取数组第一个位置的字符串的值,
!*.*s! 就是[!format_specfier!]的内容,所以我们就想知道 *.*s含义,
根据printf输出格式我们可以知道第一个星号* 表示输出宽度,点号(.)表示下面一个星号是输出精度。
故我们可以看到数组pArgs前面3个值,4 ,2,Bill 。4为要格式的宽度,2为要格式的精度,Bill为要格式的字符串。
%4 取数组第四个值的字符串,它没有format_specifier 所以按默认输出宽度和精度。
%5!*s! 表示输出的是取数组第五个值的字符串,宽度为6。
msdn还提供了一个使用va_list类型的例子:
点击(此处)折叠或打开
-
#ifndef UNICODE
-
#define UNICODE
-
#endif
-
-
#include <windows.h>
-
#include <stdio.h>
-
-
LPWSTR GetFormattedMessage(LPWSTR pMessage, );
-
-
void main(void)
-
{
-
LPWSTR pBuffer = NULL;
-
LPWSTR pMessage = L"%1!*.*s! %3 %4!*s!";
-
-
// The variable length arguments correspond directly to the format
-
// strings in pMessage.
-
pBuffer = GetFormattedMessage(pMessage, 4, 2, L"Bill", L"Bob", 6, L"Bill");
-
if (pBuffer)
-
{
-
// Buffer contains " Bi Bob Bill".
-
wprintf(L"Formatted message: %s\n", pBuffer);
-
LocalFree(pBuffer);
-
}
-
else
-
{
-
wprintf(L"Format message failed with 0x%x\n", GetLastError());
-
}
-
}
-
-
// Formats a message string using the specified message and variable
-
// list of arguments.
-
LPWSTR GetFormattedMessage(LPWSTR pMessage, )
-
{
-
LPWSTR pBuffer = NULL;
-
-
va_list args = NULL;
-
va_start(args, pMessage);
-
-
FormatMessage(FORMAT_MESSAGE_FROM_STRING |
-
FORMAT_MESSAGE_ALLOCATE_BUFFER,
-
pMessage,
-
0,
-
0,
-
(LPWSTR)&pBuffer,
-
0,
-
&args);
-
-
va_end(args);
-
-
return pBuffer;
- }
那么我们已经看完了所有的使用方法了,但是可能我们还会想Argument到底有什么用按照以上所述。
在消息资源的消息文本中我们可能会使用插入序列,让消息文本显示更加灵活。
比如我们在消息资源中的一个消息里面定义一个消息文本内容如下:
那么我们在调用消息模块的时候代码如下:
点击(此处)折叠或打开
-
DWORD_PTR pArgs[] = { (DWORD_PTR)4, (DWORD_PTR)2, (DWORD_PTR)L"Bill", // % refers back to the first insertion string in pMessage
-
(DWORD_PTR)L"Bob", // %4 refers back to the second insertion string in pMessage
-
(DWORD_PTR)6, (DWORD_PTR)L"Bill" }; // % refers back to the third insertion string in pMessage
-
if (hDll != NULL) {
-
-
fOk = FormatMessage(
-
FORMAT_MESSAGE_FROM_HMODULE | FORMAT_MESSAGE_ARGUMENT_ARRAY |
-
FORMAT_MESSAGE_ALLOCATE_BUFFER,
-
hDll, dwError, systemLocale,
-
(PTSTR) &hlocal, 0, (va_list*)pArgs);
-
FreeLibrary(hDll);
-
}
- }
原文:http://www.cppblog.com/koople/archive/2009/12/03/102367.aspx