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 FilesMicrosoft Visual Studio .NETVc7PlatformSDKInclude 下。
為查找這些常量,我在該目錄中執行了一個 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: est.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;