Chinaunix首页 | 论坛 | 博客
  • 博客访问: 521278
  • 博文数量: 136
  • 博客积分: 893
  • 博客等级: 中士
  • 技术积分: 1001
  • 用 户 组: 普通用户
  • 注册时间: 2012-03-31 09:18
个人简介

生命可以终止,梦想不会!

文章分类

全部博文(136)

文章存档

2016年(4)

2015年(2)

2014年(5)

2013年(7)

2012年(118)

分类: Windows平台

2015-01-05 16:12:53

一、常见的函数返回值数据类型

VOID 函数不可能失败,只有极少数Windows函数的返回值类型为VOID

BOOL 如果函数失败,返回值为0;否则,返回孩子是一个非0值。应避免测试返回值是否为TRUE;最稳妥的做法是检查他/她是否不为FALSE

HANDLE 如果失败返回NULL,否则,HANDLE将标识一个可以操纵的对象。某些函数可能返回 INVALID_HANDLE_VALUE的一个句柄值,它被定义为-。函数的Platform sdk文档清楚的说明了函数是返回NULL还是 INVALID_HANDLE_VALUE来表示失败

PVOID 如果韩寒苏调用失败,则返回NULL,否则,PVOID将标识一个数据块的内存地址

LONG/DWORD 这种类型比较棘手,返回计数的函数通常会返回一个LONG或DWORD。如果函数出于某种原因不能对我们想要计数的东西进行计数,它通常会返回0或-1(具体取决于函数)。如果要调用一个返回LONG/DWORD的函数,务必仔细阅读Platfrom sdk文档,确保我们会正确地检查可能出现的错误。

Format Message函数
//拽自网上
  1. DWORD WINAPI FormatMessage (
  2.                             DWORD dwFlags, // source and processing options
  3.                             LPCVOID lpSource, // message source
  4.                             DWORD dwMessageId, // message identifier
  5.                             DWORD dwLanguageId, // language identifier
  6.                             LPTSTR lpBuffer, // message buffer
  7.                             DWORD nSize, // maximum size of message buffer
  8.                             va_list *Arguments // array of message inserts
  9.                             );
dwFlags 格式化选项,对lpSource参数值有指导作用。
dwFlags的低位值指定了函数如何处理输出缓冲区处理行转换,也可以指定格式化输出字符串输出行的最大宽度。
标志位,决定如何说明lpSource参数,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会被忽略。

如果函数调用成功,返回输出缓冲区的大小,除最后一个空字符。如果失败侧返回0。

开始在上面说了dwflags参数低位值作用,你可以使用以下值来设置低位值。

 

Value

Meaning

0

将不会有输出行宽度限制。

 

FORMAT_MESSAGE_MAX_WIDTH_MASK
0x000000FF



lpSource:

这个值是消息表资源来自哪里,这个值依靠dwFlags,详细请看FORMAT_MESSAGE_FROM_HMODULEFORMAT_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!]为这个参数的指定形式。

例一:

使用系统的消息资源来报错,这也是这个函数最有用的地方。

点击(此处)折叠或打开

  1. #include <windows.h>
  2. #include <strsafe.h>
  3.   
  4. void ErrorExit(LPTSTR lpszFunction)
  5. {
  6.     // Retrieve the system error message for the last-error code
  7.   
  8.     LPVOID lpMsgBuf;
  9.     LPVOID lpDisplayBuf;
  10.     DWORD dw = GetLastError();
  11.   
  12.     FormatMessage(
  13.         FORMAT_MESSAGE_ALLOCATE_BUFFER |
  14.         FORMAT_MESSAGE_FROM_SYSTEM |
  15.         FORMAT_MESSAGE_IGNORE_INSERTS,
  16.         NULL,
  17.         dw,
  18.         MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT),
  19.         (LPTSTR) &lpMsgBuf,
  20.         0, NULL );
  21.   
  22.     // Display the error message and exit the process
  23.   
  24.     lpDisplayBuf = (LPVOID)LocalAlloc(LMEM_ZEROINIT,
  25.         (lstrlen((LPCTSTR)lpMsgBuf)+lstrlen((LPCTSTR)lpszFunction)+40)*sizeof(TCHAR));
  26.     StringCchPrintf((LPTSTR)lpDisplayBuf,
  27.         LocalSize(lpDisplayBuf),
  28.         TEXT("%s failed with error %d: %s"),
  29.         lpszFunction, dw, lpMsgBuf);
  30.     MessageBox(NULL, (LPCTSTR)lpDisplayBuf, TEXT("Error"), MB_OK);
  31.   
  32.     LocalFree(lpMsgBuf);
  33.     LocalFree(lpDisplayBuf);
  34.     ExitProcess(dw);
  35. }
  36.   
  37. void main()
  38. {
  39.     // Generate an error
  40.   
  41.     if(!GetProcessId(NULL))
  42.         ErrorExit(TEXT("GetProcessId"));
  43. }

我们可以看到函数选项dwFlags

分别为FORMAT_MESSAGE_ALLOCATE_BUFFER由函数分配输出缓冲区,

FORMAT_MESSAGE_FROM_SYSTEM表示程序将会在系统消息表资源中搜索所需消息,

FORMAT_MESSAGE_IGNORE_INSERTS程序将会忽略搜索到消息中的插入序列。

lpSource值为NULL,并没有模块值和字符串直接传入所以为NULL,详细看以上各参数解析。

dwMessageIddw,即GetLastError的返回值。就是消息资源的ID号。

dwLanguageId 设置为本地默认

lpBuffer 输出缓冲区这里注意为什么要&呢? 因为 LPVOID lpMsgBuf只是一个指针对象,那么要必须要把它的地址传给lpBuffer参数。

剩下两个参数可以上面参数的详解。

最后注意一点:由于lpBuffer这个参数的值是FormatMessage函数动态分配的缓冲区,所以在不使用的时候要LocalFree.



例二:

格式化模块中的消息资源,这里加载的模块之中要有消息资源,如果FormatMessage函数中传递了FORMAT_MESSAGE_FROM_SYSTEM,如果消息模块中没有我们所需的资源,那么将会在系统中寻找;如果没有 FORMAT_MESSAGE_FROM_SYSTEM,而且消息模块中没有我们所需资源,函数调用失败。

点击(此处)折叠或打开

  1. #include <windows.h>
  2. #include <stdio.h>
  3.   
  4. #include <lmerr.h>
  5.   
  6. void
  7. DisplayErrorText(
  8.     DWORD dwLastError
  9.     );
  10.   
  11. #define RTN_OK 0
  12. #define RTN_USAGE 1
  13. #define RTN_ERROR 13
  14.   
  15. int
  16. __cdecl
  17. main(
  18.     int argc,
  19.     char *argv[]
  20.     )
  21. {
  22.     if(argc != 2) {
  23.         fprintf(stderr,"Usage: %s \n", argv[0]);
  24.         return RTN_USAGE;
  25.     }
  26.   
  27.     DisplayErrorText( atoi(argv[1]) );
  28.   
  29.     return RTN_OK;
  30. }
  31.   
  32. void
  33. DisplayErrorText(
  34.     DWORD dwLastError
  35.     )
  36. {
  37.     HMODULE hModule = NULL; // default to system source
  38.     LPSTR MessageBuffer;
  39.     DWORD dwBufferLength;
  40.   
  41.     DWORD dwFormatFlags = FORMAT_MESSAGE_ALLOCATE_BUFFER |
  42.         FORMAT_MESSAGE_IGNORE_INSERTS |
  43.         FORMAT_MESSAGE_FROM_SYSTEM ;
  44.   
  45.     //
  46.     // If dwLastError is in the network range,
  47.     // load the message source.
  48.     //
  49.   
  50.     if(dwLastError >= NERR_BASE && dwLastError <= MAX_NERR) {
  51.         hModule = LoadLibraryEx(
  52.             TEXT("netmsg.dll"),
  53.             NULL,
  54.             LOAD_LIBRARY_AS_DATAFILE
  55.             );
  56.   
  57.         if(hModule != NULL)
  58.             dwFormatFlags |= FORMAT_MESSAGE_FROM_HMODULE;
  59.     }
  60.   
  61.     //
  62.     // Call FormatMessage() to allow for message
  63.     // text to be acquired from the system
  64.     // or from the supplied module handle.
  65.     //
  66.   
  67.     if(dwBufferLength = FormatMessageA(
  68.         dwFormatFlags,
  69.         hModule, // module to get message from (NULL == system)
  70.         dwLastError,
  71.         MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT), // default language
  72.         (LPSTR) &MessageBuffer,
  73.         0,
  74.         NULL
  75.         ))
  76.     {
  77.         DWORD dwBytesWritten;
  78.   
  79.         //
  80.         // Output message string on stderr.
  81.         //
  82.         WriteFile(
  83.             GetStdHandle(STD_ERROR_HANDLE),
  84.             MessageBuffer,
  85.             dwBufferLength,
  86.             &dwBytesWritten,
  87.             NULL
  88.             );
  89.   
  90.         //
  91.         // Free the buffer allocated by the system.
  92.         //
  93.         LocalFree(MessageBuffer);
  94.     }
  95.   
  96.     //
  97.     // If we loaded a message source, unload it.
  98.     //
  99.     if(hModule != NULL)
  100.         FreeLibrary(hModule);
  101. }

之前两个例子都是经常使用的,那么FormatMessage之中还有个参数我们没有用过的,Arguments,那么我们在什么情况下使用呢?

 我们前面已经详细解释了各个参数详细意义。我们先来看msdn两个有关使用这个值的例子:

点击(此处)折叠或打开

  1. #ifndef UNICODE
  2. #define UNICODE
  3. #endif
  4.   
  5. #include <windows.h>
  6. #include <stdio.h>
  7.   
  8. void main(void)
  9. {
  10.     LPWSTR pMessage = L"%1!*.*s! %4 %5!*s!";
  11.     DWORD_PTR pArgs[] = { (DWORD_PTR)4, (DWORD_PTR)2, (DWORD_PTR)L"Bill", // % refers back to the first insertion string in pMessage
  12.          (DWORD_PTR)L"Bob", // %4 refers back to the second insertion string in pMessage
  13.          (DWORD_PTR)6, (DWORD_PTR)L"Bill" }; // % refers back to the third insertion string in pMessage
  14.     const DWORD size = 100+1;
  15.     WCHAR buffer[size];
  16.   
  17.   
  18.     if (!FormatMessage(FORMAT_MESSAGE_FROM_STRING | FORMAT_MESSAGE_ARGUMENT_ARRAY,
  19.                        pMessage,
  20.                        0,
  21.                        0,
  22.                        buffer,
  23.                        size,
  24.                        (va_list*)pArgs))
  25.     {
  26.         wprintf(L"Format message failed with 0x%x\n", GetLastError());
  27.         return;
  28.     }
  29.   
  30.     // Buffer contains " Bi Bob Bill".
  31.     wprintf(L"Formatted message: %s\n", buffer);
  32. }

根据msdn中对Arguments参数的解释,这里插入序列遵循%n[!format_specifier!]

这个格式,如果format_specifer不清楚可以查阅printf输出格式。

FormatMessage的用法 - kulong0105 - kulong0105的博客LPWSTR pMessage = L"%1!*.*s! %4 %5!*s!";

的意义如下:

%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类型的例子:

点击(此处)折叠或打开

  1. #ifndef UNICODE
  2. #define UNICODE
  3. #endif
  4.   
  5. #include <windows.h>
  6. #include <stdio.h>
  7.   
  8. LPWSTR GetFormattedMessage(LPWSTR pMessage, );
  9.   
  10. void main(void)
  11. {
  12.     LPWSTR pBuffer = NULL;
  13.     LPWSTR pMessage = L"%1!*.*s! %3 %4!*s!";
  14.   
  15.     // The variable length arguments correspond directly to the format
  16.     // strings in pMessage.
  17.     pBuffer = GetFormattedMessage(pMessage, 4, 2, L"Bill", L"Bob", 6, L"Bill");
  18.     if (pBuffer)
  19.     {
  20.         // Buffer contains " Bi Bob Bill".
  21.         wprintf(L"Formatted message: %s\n", pBuffer);
  22.         LocalFree(pBuffer);
  23.     }
  24.     else
  25.     {
  26.         wprintf(L"Format message failed with 0x%x\n", GetLastError());
  27.     }
  28. }
  29.   
  30. // Formats a message string using the specified message and variable
  31. // list of arguments.
  32. LPWSTR GetFormattedMessage(LPWSTR pMessage, )
  33. {
  34.     LPWSTR pBuffer = NULL;
  35.   
  36.     va_list args = NULL;
  37.     va_start(args, pMessage);
  38.   
  39.     FormatMessage(FORMAT_MESSAGE_FROM_STRING |
  40.                   FORMAT_MESSAGE_ALLOCATE_BUFFER,
  41.                   pMessage,
  42.                   0,
  43.                   0,
  44.                   (LPWSTR)&pBuffer,
  45.                   0,
  46.                   &args);
  47.   
  48.     va_end(args);
  49.   
  50.     return pBuffer;
  51. }

那么我们已经看完了所有的使用方法了,但是可能我们还会想Argument到底有什么用按照以上所述。

在消息资源的消息文本中我们可能会使用插入序列,让消息文本显示更加灵活。

比如我们在消息资源中的一个消息里面定义一个消息文本内容如下:

FormatMessage的用法 - kulong0105 - kulong0105的博客%1!*.*s! %4 %5!*s!

那么我们在调用消息模块的时候代码如下:


点击(此处)折叠或打开

  1. DWORD_PTR pArgs[] = { (DWORD_PTR)4, (DWORD_PTR)2, (DWORD_PTR)L"Bill", // % refers back to the first insertion string in pMessage
  2.              (DWORD_PTR)L"Bob", // %4 refers back to the second insertion string in pMessage
  3.              (DWORD_PTR)6, (DWORD_PTR)L"Bill" }; // % refers back to the third insertion string in pMessage
  4.          if (hDll != NULL) {
  5.   
  6.             fOk = FormatMessage(
  7.                FORMAT_MESSAGE_FROM_HMODULE | FORMAT_MESSAGE_ARGUMENT_ARRAY |
  8.                FORMAT_MESSAGE_ALLOCATE_BUFFER,
  9.                hDll, dwError, systemLocale,
  10.                (PTSTR) &hlocal, 0, (va_list*)pArgs);
  11.             FreeLibrary(hDll);
  12.          }
  13.       }

原文:http://www.cppblog.com/koople/archive/2009/12/03/102367.aspx

























阅读(1250) | 评论(0) | 转发(0) |
给主人留下些什么吧!~~