FormatMessage與GetLastError配合使用，排查windows api調用過程當中的錯誤

前一段時間在學習windows api調用過程當中，遇到過一些調用錯誤或者程序沒能顯示預期的結果，或者直接出現vc運行時錯誤。

這對新手來講是司空見慣的事，由於不太熟悉不免會出錯，出錯的信息若是能顯示很好的關鍵字到網上搜索一下卻是很好的，例如

返回錯誤代碼:2。你能夠使用Visual studio套件裏面的Error Lookup查詢一下系統消息列表中的請求消息（system message-ta

ble resource(s) for the requested message）:即可得知「系統找不到指定的文件」。有的錯誤根本就不顯示什麼錯誤信息，

這可難倒新手了，我也有一些c程序所以沒能完成放置那裏窖藏了，不懂何時才能碰到他。

 

偶然間看到網上文章講解C#中使用託管代碼來排查windows api調用，讓我想起了之前下載的一段代碼，也有相似的函數，因而用

工具搜索到了這段代碼，本文的代碼片斷來自於Expat 2.1.0的win32filemap.c文件

static void
win32perror(const TCHAR *s)
{
  LPVOID buf;
  if (FormatMessage(FORMAT_MESSAGE_ALLOCATE_BUFFER
                    | FORMAT_MESSAGE_FROM_SYSTEM,
                    NULL,
                    GetLastError(),
                    MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT),
                    (LPTSTR) &buf,
                    0,
                    NULL)) {
    _ftprintf(stderr, _T("%s: %s"), s, buf);
    fflush(stderr);
    LocalFree(buf);
  }
  else
    _ftprintf(stderr, _T("%s: unknown Windows error\n"), s);
}

在此基礎上稍稍修改了一下寫了一個測試代碼，以下:

如下在windows xp sp3,visual c++ 6編譯經過

#include <windows.h>
#include <stdio.h>
#include <tchar.h>


#define STRICT 1
#define WIN32_LEAN_AND_MEAN 1
#ifndef UNICODE
#define UNICODE
#endif

static void
win32perror(const TCHAR *s)
{
    LPVOID buf;
    if (FormatMessage(FORMAT_MESSAGE_ALLOCATE_BUFFER | FORMAT_MESSAGE_IGNORE_INSERTS
        | FORMAT_MESSAGE_FROM_SYSTEM | FORMAT_MESSAGE_MAX_WIDTH_MASK,
        NULL,
        GetLastError(),
        MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT),
        (LPTSTR) &buf,
        0,
        NULL)) {
        _ftprintf(stderr, _T("%s: %s"), s, buf);
        fflush(stderr);
        LocalFree(buf);
    }
    else
        _ftprintf(stderr, _T("%s: unknown Windows error\n"), s);
}


void main(void)
{
    DWORD dwLastError;
    const TCHAR *wSZError = {"錯誤信息\0"};
    GetFileAttributes("FileNotexist.txt");
    dwLastError = GetLastError();

    
    printf("操做系統返回的錯誤代碼:%d\n",dwLastError);
    win32perror(wSZError);

}

程序運行結果:

如下是網絡上的C#代碼處理GetLastError錯誤代碼，版權歸原做者全部。

using System;
using System.ComponentModel;
// 使用平臺調用技術進行互操做性以前，首先須要添加這個命名空間
using System.Runtime.InteropServices;

namespace FormatMessageDotNet
{
    class Program
    {
        // Win32 API 
        //  DWORD WINAPI GetFileAttributes(
        //  _In_  LPCTSTR lpFileName
        //);

        // 在託管代碼中對非託管函數進行聲明
        [DllImport("Kernel32.dll",SetLastError=true,CharSet=CharSet.Unicode)]
        public static extern uint GetFileAttributes(string filename);

        static void Main(string[] args)
        {
            // 試圖得到一個不存在文件的屬性
            // 此時調用Win32函數會發生錯誤
            GetFileAttributes("FileNotexist.txt");

            // 在應用程序的Bin目錄下存在一個test.txt文件,此時調用會成功
            //GetFileAttributes("test.txt");

            // 得到最後一次得到的錯誤
            int lastErrorCode = Marshal.GetLastWin32Error();

            // 將Win32的錯誤碼轉換爲託管異常
            //Win32Exception win32exception = new Win32Exception();
            Win32Exception win32exception = new Win32Exception(lastErrorCode);
            if (lastErrorCode != 0)
            {
                Console.WriteLine("調用Win32函數發生錯誤，錯誤信息爲 : {0}", win32exception.Message);
            }
            else
            {
                Console.WriteLine("調用Win32函數成功,返回的信息爲： {0}", win32exception.Message);
            }

            Console.Read();
        }
    }
}

附:聽說使用FormatMessage會有潛在的問題,因此以上代碼繞開了這個函數。

FormatMessage函數原型:

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

其中第一個參數dwFlags開關若是用到如下參數的確會有潛在的問題。

FORMAT_MESSAGE_ALLOCATE_BUFFER 0x00000100

Windows Server 2003 and Windows XP:  

If the length of the formatted message exceeds 128K bytes, then FormatMessage will not automatically fail with an error of ERROR_MORE_DATA.

也就是消息格式化超過128字節了就會出現問題，而且不會自動報告 ERROR_MORE_DATA錯誤，之後會單獨寫一篇FormatMessage函數的詳細用法