C# win32 API程式設計
C# 使用者經常提出兩個問題：“我為什麼要另外編寫程式碼來使用內置於 Windows 中的功能？在框架中為什麼沒有相應的內容可以為我完成這一任務？”當框架小組構建他們的 .NET 部分時，他們評估了為使 .NET 程式設計師可以使用 Win32 而需要完成的工作，結果發現 Win32 API 集非常龐大。他們沒有足夠的資源為所有 Win32 API 編寫託管介面、加以測試並編寫文件，因此只能優先處理最重要的部分。許多常用操作都有託管介面，但是還有許多完整的 Win32 部分沒有託管介面。

　　平臺呼叫 (P/Invoke) 是完成這一任務的最常用方法。要使用 P/Invoke，您可以編寫一個描述如何呼叫函式的原型，然後執行時將使用此資訊進行呼叫。另一種方法是使用 Managed Extensions to C++ 來包裝函式，這部分內容將在以後的專欄中介紹。

　　要理解如何完成這一任務，最好的辦法是通過示例。在某些示例中，我只給出了部分程式碼；完整的程式碼可以通過下載獲得。

　　簡單示例

　　在第一個示例中，我們將呼叫 Beep() API 來發出聲音。首先，我需要為 Beep() 編寫適當的定義。檢視 MSDN 中的定義，我發現它具有以下原型：

BOOL Beep(
　DWORD dwFreq,　　　// 聲音訊率
　DWORD dwDuration　 // 聲音持續時間
);

　　要用 C# 來編寫這一原型，需要將 Win32 型別轉換成相應的 C# 型別。由於 DWORD 是 4 位元組的整數，因此我們可以使用 int 或 uint 作為 C# 對應型別。由於 int 是 CLS 相容型別（可以用於所有 .NET 語言），以此比 uint 更常用，並且在多數情況下，它們之間的區別並不重要。bool 型別與 BOOL 對應。現在我們可以用 C# 編寫以下原型：

public static extern bool Beep(int frequency, int duration);
　
　　這是相當標準的定義，只不過我們使用了 extern 來指明該函式的實際程式碼在別處。此原型將告訴執行時如何呼叫函式；現在我們需要告訴它在何處找到該函式。

　　我們需要回顧一下 MSDN 中的程式碼。在參考資訊中，我們發現 Beep() 是在 kernel32.lib 中定義的。這意味著執行時程式碼包含在 kernel32.dll 中。我們在原型中新增 DllImport 屬性將這一資訊告訴執行時：

[DllImport("kernel32.dll")]

　　這就是我們要做的全部工作。下面是一個完整的示例，它生成的隨機聲音在二十世紀六十年代的科幻電影中很常見。

using System;
using System.Runtime.InteropServices;

namespace Beep
{
class Class1
　{
　　　[DllImport("kernel32.dll")]
　　　public static extern bool Beep(int frequency, int duration);

　　　static void Main(string[] args)
　　　{
　　　　　Random random = new Random();

　　　　　for (int i = 0; i < 10000; i++)
　　　　　{
　　　　　　Beep(random.Next(10000), 100);
}
　　　}
　}
}

　　它的聲響足以刺激任何聽者！由於 DllImport 允許您呼叫 Win32 中的任何程式碼，因此就有可能呼叫惡意程式碼。所以您必須是完全受信任的使用者，執行時才能進行 P/Invoke 呼叫。

　　列舉和常量

　　Beep() 可用於發出任意聲音，但有時我們希望發出特定型別的聲音，因此我們改用 MessageBeep()。MSDN 給出了以下原型：

BOOL MessageBeep(
　UINT uType // 聲音型別
);

　　這看起來很簡單，但是從註釋中可以發現兩個有趣的事實。

　　首先，uType 引數實際上接受一組預先定義的常量。

　　其次，可能的引數值包括 -1，這意味著儘管它被定義為 uint 型別，但 int 會更加適合。

　　對於 uType 引數，使用 enum 型別是合乎情理的。MSDN 列出了已命名的常量，但沒有就具體值給出任何提示。由於這一點，我們需要檢視實際的 API。

　　如果您安裝了 Visual Studio? 和 C++，則 Platform SDK 位於 /Program Files/Microsoft Visual Studio .NET/Vc7/PlatformSDK/Include 下。

　　為查詢這些常量，我在該目錄中執行了一個 findstr。

　　findstr "MB_ICONHAND" *.h

　　它確定了常量位於 winuser.h 中，然後我使用這些常量來建立我的 enum 和原型：

public enum BeepType
{
　 SimpleBeep = -1,
　 IconAsterisk = 0x00000040,
　 IconExclamation = 0x00000030,
　 IconHand = 0x00000010,
　 IconQuestion = 0x00000020,
　 Ok = 0x00000000,
}

[DllImport("user32.dll")]
public static extern bool MessageBeep(BeepType beepType);

　　現在我可以用下面的語句來呼叫它： MessageBeep(BeepType.IconQuestion);
處理結構

　　有時我需要確定我筆記本的電池狀況。Win32 為此提供了電源管理函式。

　　搜尋 MSDN 可以找到 GetSystemPowerStatus() 函式。

BOOL GetSystemPowerStatus(
　LPSYSTEM_POWER_STATUS lpSystemPowerStatus
);

　　此函式包含指向某個結構的指標，我們尚未對此進行過處理。要處理結構，我們需要用 C# 定義結構。我們從非託管的定義開始：

typedef struct _SYSTEM_POWER_STATUS {
BYTE　 ACLineStatus;
BYTE　 BatteryFlag;
BYTE　 BatteryLifePercent;
BYTE　 Reserved1;
DWORD　BatteryLifeTime;
DWORD　BatteryFullLifeTime;
} SYSTEM_POWER_STATUS, *LPSYSTEM_POWER_STATUS;

　　然後，通過用 C# 型別代替 C 型別來得到 C# 版本。

struct SystemPowerStatus
{
　 byte ACLineStatus;
　 byte batteryFlag;
　 byte batteryLifePercent;
　 byte reserved1;
　 int batteryLifeTime;
　 int batteryFullLifeTime;
}

　　這樣，就可以方便地編寫出 C# 原型：

[DllImport("kernel32.dll")]
public static extern bool GetSystemPowerStatus(
　 ref SystemPowerStatus systemPowerStatus);

　　在此原型中，我們用“ref”指明將傳遞結構指標而不是結構值。這是處理通過指標傳遞的結構的一般方法。

　　此函式執行良好，但是最好將 ACLineStatus 和 batteryFlag 欄位定義為 enum：

　　enum ACLineStatus: byte
　　{
　　　Offline = 0,
　　　Online = 1,
　　　Unknown = 255,
　　}

　　enum BatteryFlag: byte
　　{
　　　High = 1,
　　　Low = 2,
　　　Critical = 4,
　　　Charging = 8,
　　　NoSystemBattery = 128,
　　　Unknown = 255,
　　}

　　請注意，由於結構的欄位是一些位元組，因此我們使用 byte 作為該 enum 的基本型別。

　　字串

　　雖然只有一種 .NET 字串型別，但這種字串型別在非託管應用中卻有幾項獨特之處。可以使用具有內嵌字元陣列的字元指標和結構，其中每個陣列都需要正確的封送處理。

　　在 Win32 中還有兩種不同的字串表示：

　　ANSI
　　Unicode

　　最初的 Windows 使用單位元組字元，這樣可以節省儲存空間，但在處理很多語言時都需要複雜的多位元組編碼。Windows NT? 出現後，它使用雙位元組的 Unicode 編碼。為解決這一差別，Win32 API 採用了非常聰明的做法。它定義了 TCHAR 型別，該型別在 Win9x 平臺上是單位元組字元，在 WinNT 平臺上是雙位元組 Unicode 字元。對於每個接受字串或結構（其中包含字元資料）的函式，Win32 API 均定義了該結構的兩種版本，用 A 字尾指明 Ansi 編碼，用 W 指明 wide 編碼（即 Unicode）。如果您將 C++ 程式編譯為單位元組，會獲得 A 變體，如果編譯為 Unicode，則獲得 W 變體。Win9x 平臺包含 Ansi 版本，而 WinNT 平臺則包含 W 版本。

　　由於 P/Invoke 的設計者不想讓您為所在的平臺操心，因此他們提供了內建的支援來自動使用 A 或 W 版本。如果您呼叫的函式不存在，互操作層將為您查詢並使用 A 或 W 版本。

　　通過示例能夠很好地說明字串支援的一些精妙之處。

　　簡單字串

　　下面是一個接受字串引數的函式的簡單示例：

BOOL GetDiskFreeSpace(
LPCTSTR lpRootPathName, 　　　　// 根路徑
LPDWORD lpSectorsPerCluster,　　// 每個簇的扇區數
LPDWORD lpBytesPerSector,　　　 // 每個扇區的位元組數
LPDWORD lpNumberOfFreeClusters, // 可用的扇區數
LPDWORD lpTotalNumberOfClusters // 扇區總數
);

　　根路徑定義為 LPCTSTR。這是獨立於平臺的字串指標。

　　由於不存在名為 GetDiskFreeSpace() 的函式，封送拆收器將自動查詢“A”或“W”變體，並呼叫相應的函式。我們使用一個屬性來告訴封送拆收器，API 所要求的字串型別。

　　以下是該函式的完整定義，就象我開始定義的那樣：

[DllImport("kernel32.dll")]
static extern bool GetDiskFreeSpace(
　[MarshalAs(UnmanagedType.LPTStr)]
　string rootPathName,
　 ref int sectorsPerCluster,
　 ref int bytesPerSector,
　 ref int numberOfFreeClusters,
　 ref int totalNumberOfClusters);

　　不幸的是，當我試圖執行時，該函式不能執行。問題在於，無論我們在哪個平臺上，封送拆收器在預設情況下都試圖查詢 API 的 Ansi 版本，由於 LPTStr 意味著在 Windows NT 平臺上會使用 Unicode 字串，因此試圖用 Unicode 字串來呼叫 Ansi 函式就會失敗。

　　有兩種方法可以解決這個問題：一種簡單的方法是刪除 MarshalAs 屬性。如果這樣做，將始終呼叫該函式的 A 版本，如果在您所涉及的所有平臺上都有這種版本，這是個很好的方法。但是，這會降低程式碼的執行速度，因為封送拆收器要將 .NET 字串從 Unicode 轉換為多位元組，然後呼叫函式的 A 版本（將字串轉換回 Unicode），最後呼叫函式的 W 版本。

　　要避免出現這種情況，您需要告訴封送拆收器，要它在 Win9x 平臺上時查詢 A 版本，而在 NT 平臺上時查詢 W 版本。要實現這一目的，可以將 CharSet 設定為 DllImport 屬性的一部分：

[DllImport("kernel32.dll", CharSet = CharSet.Auto)] 
　　
　　在我的非正式計時測試中，我發現這一做法比前一種方法快了大約百分之五。

　　對於大多數 Win32 API，都可以對字串型別設定 CharSet 屬性並使用 LPTStr。但是，還有一些不採用 A/W 機制的函式，對於這些函式必須採取不同的方法。

　　字串緩衝區

　　.NET 中的字串型別是不可改變的型別，這意味著它的值將永遠保持不變。對於要將字串值複製到字串緩衝區的函式，字串將無效。這樣做至少會破壞由封送拆收器在轉換字串時建立的臨時緩衝區；嚴重時會破壞託管堆，而這通常會導致錯誤的發生。無論哪種情況都不可能獲得正確的返回值。

　　要解決此問題，我們需要使用其他型別。StringBuilder 型別就是被設計為用作緩衝區的，我們將使用它來代替字串。下面是一個示例：

[DllImport("kernel32.dll", CharSet = CharSet.Auto)]
public static extern int GetShortPathName(
　 [MarshalAs(UnmanagedType.LPTStr)]
　 string path,
　 [MarshalAs(UnmanagedType.LPTStr)]
　 StringBuilder shortPath,
　 int shortPathLength);

　　使用此函式很簡單：

StringBuilder shortPath = new StringBuilder(80);
int result = GetShortPathName(@"d:/test.jpg", shortPath, shortPath.Capacity);
string s = shortPath.ToString();

　　請注意，StringBuilder 的 Capacity 傳遞的是緩衝區大小。

　　具有內嵌字元陣列的結構

　　某些函式接受具有內嵌字元陣列的結構。例如，GetTimeZoneInformation() 函式接受指向以下結構的指標：

typedef struct _TIME_ZONE_INFORMATION {
　　LONG　　　 Bias;
　　WCHAR　　　StandardName[ 32 ];
　　SYSTEMTIME StandardDate;
　　LONG　　　 StandardBias;
　　WCHAR　　　DaylightName[ 32 ];
　　SYSTEMTIME DaylightDate;
　　LONG　　　 DaylightBias;
} TIME_ZONE_INFORMATION, *PTIME_ZONE_INFORMATION;

　　在 C# 中使用它需要有兩種結構。一種是 SYSTEMTIME，它的設定很簡單：

　 struct SystemTime
　 {
　　　public short wYear;
　　　public short wMonth;
　　　public short wDayOfWeek;
　　　public short wDay;
　　　public short wHour;
　　　public short wMinute;
　　　public short wSecond;
　　　public short wMilliseconds;
　 }

　　這裡沒有什麼特別之處；另一種是 TimeZoneInformation，它的定義要複雜一些：

[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
struct TimeZoneInformation
{
　 public int bias;
　 [MarshalAs(UnmanagedType.ByValTStr, SizeConst = 32)]
　 public string standardName;
　 SystemTime standardDate;
　 public int standardBias;
　 [MarshalAs(UnmanagedType.ByValTStr, SizeConst = 32)]
　 public string daylightName;
　 SystemTime daylightDate;
　 public int daylightBias;
}

　　此定義有兩個重要的細節。第一個是 MarshalAs 屬性：

[MarshalAs(UnmanagedType.ByValTStr, SizeConst = 32)] 
　
　　檢視 ByValTStr 的文件，我們發現該屬性用於內嵌的字元陣列；另一個是 SizeConst，它用於設定陣列的大小。

　　我在第一次編寫這段程式碼時，遇到了執行引擎錯誤。通常這意味著部分互操作覆蓋了某些記憶體，表明結構的大小存在錯誤。我使用 Marshal.SizeOf() 來獲取所使用的封送拆收器的大小，結果是 108 位元組。我進一步進行了調查，很快回憶起用於互操作的預設字元型別是 Ansi 或單位元組。而函式定義中的字元型別為 WCHAR，是雙位元組，因此導致了這一問題。

　　我通過新增 StructLayout 屬性進行了更正。結構在預設情況下按順序佈局，這意味著所有欄位都將以它們列出的順序排列。CharSet 的值被設定為 Unicode，以便始終使用正確的字元型別。

　　經過這樣處理後，該函式一切正常。您可能想知道我為什麼不在此函式中使用 CharSet.Auto。這是因為，它也沒有 A 和 W 變體，而始終使用 Unicode 字串，因此我採用了上述方法編碼。

　　具有回撥的函式

　　當 Win32 函式需要返回多項資料時，通常都是通過回撥機制來實現的。開發人員將函式指標傳遞給函式，然後針對每一項呼叫開發人員的函式。

　　在 C# 中沒有函式指標，而是使用“委託”，在呼叫 Win32 函式時使用委託來代替函式指標。

　　EnumDesktops() 函式就是這類函式的一個示例：

BOOL EnumDesktops(
　HWINSTA hwinsta,　　　　　　 // 視窗例項的控制代碼
　DESKTOPENUMPROC lpEnumFunc,　// 回撥函式
　LPARAM lParam　　　　　　　　// 用於回撥函式的值
);

　　HWINSTA 型別由 IntPtr 代替，而 LPARAM 由 int 代替。DESKTOPENUMPROC 所需的工作要多一些。下面是 MSDN 中的定義：

BOOL CALLBACK EnumDesktopProc(
　LPTSTR lpszDesktop,　// 桌面名稱
　LPARAM lParam　　　　// 使用者定義的值
);

　　我們可以將它轉換為以下委託：

delegate bool EnumDesktopProc([MarshalAs(UnmanagedType.LPTStr)] string desktopName,int lParam);

　　完成該定義後，我們可以為 EnumDesktops() 編寫以下定義：

[DllImport("user32.dll", CharSet = CharSet.Auto)]
static extern bool EnumDesktops(
　 IntPtr windowStation,
　 EnumDesktopProc callback,
　 int lParam);

　　這樣該函式就可以正常運行了。

　　在互操作中使用委託時有個很重要的技巧：封送拆收器建立了指向委託的函式指標，該函式指標被傳遞給非託管函式。但是，封送拆收器無法確定非託管函式要使用函式指標做些什麼，因此它假定函式指標只需在呼叫該函式時有效即可。

　　結果是如果您呼叫諸如 SetConsoleCtrlHandler() 這樣的函式，其中的函式指標將被儲存以便將來使用，您就需要確保在您的程式碼中引用委託。如果不這樣做，函式可能表面上能執行，但在將來的記憶體回收處理中會刪除委託，並且會出現錯誤。

　　其他高階函式

　　迄今為止我列出的示例都比較簡單，但是還有很多更復雜的 Win32 函式。下面是一個示例：

DWORD SetEntriesInAcl(
　ULONG cCountOfExplicitEntries,　　　　　　// 項數
　PEXPLICIT_ACCESS pListOfExplicitEntries, // 緩衝區
　PACL OldAcl,　　　　　　　　　　　　　　 // 原始 ACL
　PACL *NewAcl　　　　　　　　　　　　　　　// 新 ACL
);

　　前兩個引數的處理比較簡單：ulong 很簡單，並且可以使用 UnmanagedType.LPArray 來封送緩衝區。

　　但第三和第四個引數有一些問題。問題在於定義 ACL 的方式。ACL 結構僅定義了 ACL 標頭，而緩衝區的其餘部分由 ACE 組成。ACE 可以具有多種不同型別，並且這些不同型別的 ACE 的長度也不同。

　　如果您願意為所有緩衝區分配空間，並且願意使用不太安全的程式碼，則可以用 C# 進行處理。但工作量很大，並且程式非常難除錯。而使用 C++ 處理此 API 就容易得多。

　　屬性的其他選項

　　DLLImport 和 StructLayout 屬性具有一些非常有用的選項，有助於 P/Invoke 的使用。下面列出了所有這些選項：

　　DLLImport

　　CallingConvention

　　您可以用它來告訴封送拆收器，函式使用了哪些呼叫約定。您可以將它設定為您的函式的呼叫約定。通常，如果此設定錯誤，程式碼將不能執行。但是，如果您的函式是 Cdecl 函式，並且使用 StdCall（預設）來呼叫該函式，那麼函式能夠執行，但函式引數不會從堆疊中刪除，這會導致堆疊被填滿。

　　CharSet

　　控制呼叫 A 變體還是呼叫 W 變體。

　　EntryPoint

　　此屬性用於設定封送拆收器在 DLL 中查詢的名稱。設定此屬性後，您可以將 C# 函式重新命名為任何名稱。

　　ExactSpelling

　　將此屬性設定為 true，封送拆收器將關閉 A 和 W 的查詢特性。

　　PreserveSig

　　COM 互操作使得具有最終輸出引數的函式看起來是由它返回的該值。此屬性用於關閉這一特性。

　　SetLastError

　　確保呼叫 Win32 API SetLastError()，以便您找出發生的錯誤。

　　StructLayout

　　LayoutKind

　　結構在預設情況下按順序佈局，並且在多數情況下都適用。如果需要完全控制結構成員所放置的位置，可以使用 LayoutKind.Explicit，然後為每個結構成員新增 FieldOffset 屬性。當您需要建立 union 時，通常需要這樣做。

　　CharSet

　　控制 ByValTStr 成員的預設字元型別。

　　Pack

　　設定結構的壓縮大小。它控制結構的排列方式。如果 C 結構採用了其他壓縮方式，您可能需要設定此屬性。

　　Size

　　設定結構大小。不常用；但是如果需要在結構末尾分配額外的空間，則可能會用到此屬性。

　　從不同位置載入

　　您無法指定希望 DLLImport 在執行時從何處查詢檔案，但是可以利用一個技巧來達到這一目的。
    　DllImport 呼叫 LoadLibrary() 來完成它的工作。如果程序中已經載入了特定的 DLL，那麼即使指定的載入路徑不同，LoadLibrary() 也會成功。

　　這意味著如果直接呼叫 LoadLibrary()，您就可以從任何位置載入 DLL，然後 DllImport LoadLibrary() 將使用該 DLL。

　　由於這種行為，我們可以提前呼叫 LoadLibrary()，從而將您的呼叫指向其他 DLL。如果您在編寫庫，可以通過呼叫 GetModuleHandle() 來防止出現這種情況，以確保在首次呼叫 P/Invoke 之前沒有載入該庫。

　　P/Invoke 疑難解答

　　如果您的 P/Invoke 呼叫失敗，通常是因為某些型別的定義不正確。以下是幾個常見問題：

　　1.long != long。在 C++ 中，long 是 4 位元組的整數，但在 C# 中，它是 8 位元組的整數。

　　2.字串型別設定不正確。