C# 用戶經(jīng)常提出兩個(gè)問題：“我為什么要另外編寫代碼來使用內(nèi)置于 Windows 中的功能？在框架中為什么沒有相應(yīng)的內(nèi)容可以為我完成這一任務(wù)？”當(dāng)框架小組構(gòu)建他們的 .NET 部分時(shí)，他們?cè)u(píng)估了為使 .NET 程序員可以使用 Win32 而需要完成的工作，結(jié)果發(fā)現(xiàn) Win32 API 集非常龐大。他們沒有足夠的資源為所有 Win32 API 編寫托管接口、加以測(cè)試并編寫文檔，因此只能優(yōu)先處理最重要的部分。許多常用操作都有托管接口，但是還有許多完整的 Win32 部分沒有托管接口。
平臺(tái)調(diào)用 (P/Invoke) 是完成這一任務(wù)的最常用方法。要使用 P/Invoke，您可以編寫一個(gè)描述如何調(diào)用函數(shù)的原型，然后運(yùn)行時(shí)將使用此信息進(jìn)行調(diào)用。另一種方法是使用 Managed Extensions to C++ 來包裝函數(shù)，這部分內(nèi)容將在以后的專欄中介紹。
要理解如何完成這一任務(wù)，最好的辦法是通過示例。在某些示例中，我只給出了部分代碼；完整的代碼可以通過下載獲得。
簡(jiǎn)單示例
在第一個(gè)示例中，我們將調(diào)用 Beep() API 來發(fā)出聲音。首先，我需要為 Beep() 編寫適當(dāng)?shù)亩x。查看 MSDN 中的定義，我發(fā)現(xiàn)它具有以下原型： BOOL Beep(
DWORD dwFreq, // 聲音頻率
DWORD dwDuration // 聲音持續(xù)時(shí)間
);
要用 C# 來編寫這一原型，需要將 Win32 類型轉(zhuǎn)換成相應(yīng)的 C# 類型。由于 DWORD 是 4 字節(jié)的整數(shù)，因此我們可以使用 int 或 uint 作為 C# 對(duì)應(yīng)類型。由于 int 是 CLS 兼容類型（可以用于所有 .NET 語言），以此比 uint 更常用，并且在多數(shù)情況下，它們之間的區(qū)別并不重要。bool 類型與 BOOL 對(duì)應(yīng)。現(xiàn)在我們可以用 C# 編寫以下原型： public static extern bool Beep(int frequency, int duration);
這是相當(dāng)標(biāo)準(zhǔn)的定義，只不過我們使用了 extern 來指明該函數(shù)的實(shí)際代碼在別處。此原型將告訴運(yùn)行時(shí)如何調(diào)用函數(shù)；現(xiàn)在我們需要告訴它在何處找到該函數(shù)。
我們需要回顧一下 MSDN 中的代碼。在參考信息中，我們發(fā)現(xiàn) Beep() 是在 kernel32.lib 中定義的。這意味著運(yùn)行時(shí)代碼包含在 kernel32.dll 中。我們?cè)谠椭刑砑?DllImport 屬性將這一信息告訴運(yùn)行時(shí)： [DllImport("kernel32.dll")]
這就是我們要做的全部工作。下面是一個(gè)完整的示例，它生成的隨機(jī)聲音在二十世紀(jì)六十年代的科幻電影中很常見。 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 允許您調(diào)用 Win32 中的任何代碼，因此就有可能調(diào)用惡意代碼。所以您必須是完全受信任的用戶，運(yùn)行時(shí)才能進(jìn)行 P/Invoke 調(diào)用。
枚舉和常量
Beep() 可用于發(fā)出任意聲音，但有時(shí)我們希望發(fā)出特定類型的聲音，因此我們改用 MessageBeep()。MSDN 給出了以下原型： BOOL MessageBeep(
UINT uType // 聲音類型
);
這看起來很簡(jiǎn)單，但是從注釋中可以發(fā)現(xiàn)兩個(gè)有趣的事實(shí)。
首先，uType 參數(shù)實(shí)際上接受一組預(yù)先定義的常量。
其次，可能的參數(shù)值包括 -1，這意味著盡管它被定義為 uint 類型，但 int 會(huì)更加適合。
對(duì)于 uType 參數(shù)，使用 enum 類型是合乎情理的。MSDN 列出了已命名的常量，但沒有就具體值給出任何提示。由于這一點(diǎn)，我們需要查看實(shí)際的 API。
如果您安裝了 Visual Studio? 和 C++，則 Platform SDK 位于 \Program Files\Microsoft Visual Studio .NET\Vc7\PlatformSDK\Include 下。
為查找這些常量，我在該目錄中執(zhí)行了一個(gè) findstr。
findstr "MB_ICONHAND" *.h
它確定了常量位于 winuser.h 中，然后我使用這些常量來創(chuàng)建我的 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);
現(xiàn)在我可以用下面的語句來調(diào)用它： MessageBeep(BeepType.IconQuestion);
處理結(jié)構(gòu)
有時(shí)我需要確定我筆記本的電池狀況。Win32 為此提供了電源管理函數(shù)。
搜索 MSDN 可以找到 GetSystemPowerStatus() 函數(shù)。 BOOL GetSystemPowerStatus(
LPSYSTEM_POWER_STATUS lpSystemPowerStatus
);
此函數(shù)包含指向某個(gè)結(jié)構(gòu)的指針，我們尚未對(duì)此進(jìn)行過處理。要處理結(jié)構(gòu)，我們需要用 C# 定義結(jié)構(gòu)。我們從非托管的定義開始： 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”指明將傳遞結(jié)構(gòu)指針而不是結(jié)構(gòu)值。這是處理通過指針傳遞的結(jié)構(gòu)的一般方法。
此函數(shù)運(yùn)行良好，但是最好將 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,
}
請(qǐng)注意，由于結(jié)構(gòu)的字段是一些字節(jié)，因此我們使用 byte 作為該 enum 的基本類型。
字符串
雖然只有一種 .NET 字符串類型，但這種字符串類型在非托管應(yīng)用中卻有幾項(xiàng)獨(dú)特之處�？梢允褂镁哂袃�(nèi)嵌字符數(shù)組的字符指針和結(jié)構(gòu)，其中每個(gè)數(shù)組都需要正確的封送處理。
在 Win32 中還有兩種不同的字符串表示：
ANSI
Unicode
最初的 Windows 使用單字節(jié)字符，這樣可以節(jié)省存儲(chǔ)空間，但在處理很多語言時(shí)都需要復(fù)雜的多字節(jié)編碼。Windows NT? 出現(xiàn)后，它使用雙字節(jié)的 Unicode 編碼。為解決這一差別，Win32 API 采用了非常聰明的做法。它定義了 TCHAR 類型，該類型在 Win9x 平臺(tái)上是單字節(jié)字符，在 WinNT 平臺(tái)上是雙字節(jié) Unicode 字符。對(duì)于每個(gè)接受字符串或結(jié)構(gòu)（其中包含字符數(shù)據(jù)）的函數(shù)，Win32 API 均定義了該結(jié)構(gòu)的兩種版本，用 A 后綴指明 Ansi 編碼，用 W 指明 wide 編碼（即 Unicode）。如果您將 C++ 程序編譯為單字節(jié)，會(huì)獲得 A 變體，如果編譯為 Unicode，則獲得 W 變體。Win9x 平臺(tái)包含 Ansi 版本，而 WinNT 平臺(tái)則包含 W 版本。
由于 P/Invoke 的設(shè)計(jì)者不想讓您為所在的平臺(tái)操心，因此他們提供了內(nèi)置的支持來自動(dòng)使用 A 或 W 版本。如果您調(diào)用的函數(shù)不存在，互操作層將為您查找并使用 A 或 W 版本。
通過示例能夠很好地說明字符串支持的一些精妙之處。
簡(jiǎn)單字符串
下面是一個(gè)接受字符串參數(shù)的函數(shù)的簡(jiǎn)單示例： BOOL GetDiskFreeSpace(
LPCTSTR lpRootPathName, // 根路徑
LPDWORD lpSectorsPerCluster, // 每個(gè)簇的扇區(qū)數(shù)
LPDWORD lpBytesPerSector, // 每個(gè)扇區(qū)的字節(jié)數(shù)
LPDWORD lpNumberOfFreeClusters, // 可用的扇區(qū)數(shù)
LPDWORD lpTotalNumberOfClusters // 扇區(qū)總數(shù)
);
根路徑定義為 LPCTSTR。這是獨(dú)立于平臺(tái)的字符串指針。
由于不存在名為 GetDiskFreeSpace() 的函數(shù)，封送拆收器將自動(dòng)查找“A”或“W”變體，并調(diào)用相應(yīng)的函數(shù)。我們使用一個(gè)屬性來告訴封送拆收器，API 所要求的字符串類型。
以下是該函數(shù)的完整定義，就象我開始定義的那樣： [DllImport("kernel32.dll")]
static extern bool GetDiskFreeSpace(
[MarshalAs(UnmanagedType.LPTStr)]
string rootPathName,
ref int sectorsPerCluster,
ref int bytesPerSector,
ref int numberOfFreeClusters,
ref int totalNumberOfClusters);
不幸的是，當(dāng)我試圖運(yùn)行時(shí)，該函數(shù)不能執(zhí)行。問題在于，無論我們?cè)谀膫�(gè)平臺(tái)上，封送拆收器在默認(rèn)情況下都試圖查找 API 的 Ansi 版本，由于 LPTStr 意味著在 Windows NT 平臺(tái)上會(huì)使用 Unicode 字符串，因此試圖用 Unicode 字符串來調(diào)用 Ansi 函數(shù)就會(huì)失敗。
有兩種方法可以解決這個(gè)問題：一種簡(jiǎn)單的方法是刪除 MarshalAs 屬性。如果這樣做，將始終調(diào)用該函數(shù)的 A 版本，如果在您所涉及的所有平臺(tái)上都有這種版本，這是個(gè)很好的方法。但是，這會(huì)降低代碼的執(zhí)行速度，因?yàn)榉馑筒鹗掌饕獙?.NET 字符串從 Unicode 轉(zhuǎn)換為多字節(jié)，然后調(diào)用函數(shù)的 A 版本（將字符串轉(zhuǎn)換回 Unicode），最后調(diào)用函數(shù)的 W 版本。
要避免出現(xiàn)這種情況，您需要告訴封送拆收器，要它在 Win9x 平臺(tái)上時(shí)查找 A 版本，而在 NT 平臺(tái)上時(shí)查找 W 版本。要實(shí)現(xiàn)這一目的，可以將 CharSet 設(shè)置為 DllImport 屬性的一部分： [DllImport("kernel32.dll", CharSet = CharSet.Auto)]
在我的非正式計(jì)時(shí)測(cè)試中，我發(fā)現(xiàn)這一做法比前一種方法快了大約百分之五。
對(duì)于大多數(shù) Win32 API，都可以對(duì)字符串類型設(shè)置 CharSet 屬性并使用 LPTStr。但是，還有一些不采用 A/W 機(jī)制的函數(shù)，對(duì)于這些函數(shù)必須采取不同的方法。
字符串緩沖區(qū)
.NET 中的字符串類型是不可改變的類型，這意味著它的值將永遠(yuǎn)保持不變。對(duì)于要將字符串值復(fù)制到字符串緩沖區(qū)的函數(shù)，字符串將無效。這樣做至少會(huì)破壞由封送拆收器在轉(zhuǎn)換字符串時(shí)創(chuàng)建的臨時(shí)緩沖區(qū)；嚴(yán)重時(shí)會(huì)破壞托管堆，而這通常會(huì)導(dǎo)致錯(cuò)誤的發(fā)生。無論哪種情況都不可能獲得正確的返回值。
要解決此問題，我們需要使用其他類型。StringBuilder 類型就是被設(shè)計(jì)為用作緩沖區(qū)的，我們將使用它來代替字符串。下面是一個(gè)示例： [DllImport("kernel32.dll", CharSet = CharSet.Auto)]
public static extern int GetShortPathName(
[MarshalAs(UnmanagedType.LPTStr)]
string path,
[MarshalAs(UnmanagedType.LPTStr)]
StringBuilder shortPath,
int shortPathLength);
使用此函數(shù)很簡(jiǎn)單： StringBuilder shortPath = new StringBuilder(80);
int result = GetShortPathName(@"d:\test.jpg", shortPath, shortPath.Capacity);
string s = shortPath.ToString();
請(qǐng)注意，StringBuilder 的 Capacity 傳遞的是緩沖區(qū)大小。
具有內(nèi)嵌字符數(shù)組的結(jié)構(gòu)
某些函數(shù)接受具有內(nèi)嵌字符數(shù)組的結(jié)構(gòu)。例如，GetTimeZoneInformation() 函數(shù)接受指向以下結(jié)構(gòu)的指針： 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# 中使用它需要有兩種結(jié)構(gòu)。一種是 SYSTEMTIME，它的設(shè)置很簡(jiǎn)單： 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，它的定義要復(fù)雜一些： [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;
}
此定義有兩個(gè)重要的細(xì)節(jié)。第一個(gè)是 MarshalAs 屬性： [MarshalAs(UnmanagedType.ByValTStr, SizeConst = 32)]
查看 ByValTStr 的文檔，我們發(fā)現(xiàn)該屬性用于內(nèi)嵌的字符數(shù)組；另一個(gè)是 SizeConst，它用于設(shè)置數(shù)組的大小。
我在第一次編寫這段代碼時(shí)，遇到了執(zhí)行引擎錯(cuò)誤。通常這意味著部分互操作覆蓋了某些內(nèi)存，表明結(jié)構(gòu)的大小存在錯(cuò)誤。我使用 Marshal.SizeOf() 來獲取所使用的封送拆收器的大小，結(jié)果是 108 字節(jié)。我進(jìn)一步進(jìn)行了調(diào)查，很快回憶起用于互操作的默認(rèn)字符類型是 Ansi 或單字節(jié)。而函數(shù)定義中的字符類型為 WCHAR，是雙字節(jié)，因此導(dǎo)致了這一問題。
我通過添加 StructLayout 屬性進(jìn)行了更正。結(jié)構(gòu)在默認(rèn)情況下按順序布局，這意味著所有字段都將以它們列出的順序排列。CharSet 的值被設(shè)置為 Unicode，以便始終使用正確的字符類型。
經(jīng)過這樣處理后，該函數(shù)一切正常。您可能想知道我為什么不在此函數(shù)中使用 CharSet.Auto。這是因?yàn)�，它也沒有 A 和 W 變體，而始終使用 Unicode 字符串，因此我采用了上述方法編碼。
具有回調(diào)的函數(shù)
當(dāng) Win32 函數(shù)需要返回多項(xiàng)數(shù)據(jù)時(shí)，通常都是通過回調(diào)機(jī)制來實(shí)現(xiàn)的。開發(fā)人員將函數(shù)指針傳遞給函數(shù)，然后針對(duì)每一項(xiàng)調(diào)用開發(fā)人員的函數(shù)。
在 C# 中沒有函數(shù)指針，而是使用“委托”，在調(diào)用 Win32 函數(shù)時(shí)使用委托來代替函數(shù)指針。
EnumDesktops() 函數(shù)就是這類函數(shù)的一個(gè)示例： BOOL EnumDesktops(
HWINSTA hwinsta, // 窗口實(shí)例的句柄
DESKTOPENUMPROC lpEnumFunc, // 回調(diào)函數(shù)
LPARAM lParam // 用于回調(diào)函數(shù)的值
);
HWINSTA 類型由 IntPtr 代替，而 LPARAM 由 int 代替。DESKTOPENUMPROC 所需的工作要多一些。下面是 MSDN 中的定義： BOOL CALLBACK EnumDesktopProc(
LPTSTR lpszDesktop, // 桌面名稱
LPARAM lParam // 用戶定義的值
);
我們可以將它轉(zhuǎn)換為以下委托： 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);
這樣該函數(shù)就可以正常運(yùn)行了。
在互操作中使用委托時(shí)有個(gè)很重要的技巧：封送拆收器創(chuàng)建了指向委托的函數(shù)指針，該函數(shù)指針被傳遞給非托管函數(shù)。但是，封送拆收器無法確定非托管函數(shù)要使用函數(shù)指針做些什么，因此它假定函數(shù)指針只需在調(diào)用該函數(shù)時(shí)有效即可。
結(jié)果是如果您調(diào)用諸如 SetConsoleCtrlHandler() 這樣的函數(shù)，其中的函數(shù)指針將被保存以便將來使用，您就需要確保在您的代碼中引用委托。如果不這樣做，函數(shù)可能表面上能執(zhí)行，但在將來的內(nèi)存回收處理中會(huì)刪除委托，并且會(huì)出現(xiàn)錯(cuò)誤。
其他高級(jí)函數(shù)
迄今為止我列出的示例都比較簡(jiǎn)單，但是還有很多更復(fù)雜的 Win32 函數(shù)。下面是一個(gè)示例：
DWORD SetEntriesInAcl(
ULONG cCountOfExplicitEntries, // 項(xiàng)數(shù)
PEXPLICIT_ACCESS pListOfExplicitEntries, // 緩沖區(qū)
PACL OldAcl, // 原始 ACL
PACL *NewAcl // 新 ACL
);
前兩個(gè)參數(shù)的處理比較簡(jiǎn)單：ulong 很簡(jiǎn)單，并且可以使用 UnmanagedType.LPArray 來封送緩沖區(qū)。
但第三和第四個(gè)參數(shù)有一些問題。問題在于定義 ACL 的方式。ACL 結(jié)構(gòu)僅定義了 ACL 標(biāo)頭，而緩沖區(qū)的其余部分由 ACE 組成。ACE 可以具有多種不同類型，并且這些不同類型的 ACE 的長(zhǎng)度也不同。
如果您愿意為所有緩沖區(qū)分配空間，并且愿意使用不太安全的代碼，則可以用 C# 進(jìn)行處理。但工作量很大，并且程序非常難調(diào)試。而使用 C++ 處理此 API 就容易得多。
屬性的其他選項(xiàng)
DLLImport 和 StructLayout 屬性具有一些非常有用的選項(xiàng)，有助于 P/Invoke 的使用。下面列出了所有這些選項(xiàng)：
DLLImport
CallingConvention
您可以用它來告訴封送拆收器，函數(shù)使用了哪些調(diào)用約定。您可以將它設(shè)置為您的函數(shù)的調(diào)用約定。通常，如果此設(shè)置錯(cuò)誤，代碼將不能執(zhí)行。但是，如果您的函數(shù)是 Cdecl 函數(shù)，并且使用 StdCall（默認(rèn)）來調(diào)用該函數(shù)，那么函數(shù)能夠執(zhí)行，但函數(shù)參數(shù)不會(huì)從堆棧中刪除，這會(huì)導(dǎo)致堆棧被填滿。
CharSet
控制調(diào)用 A 變體還是調(diào)用 W 變體。
EntryPoint
此屬性用于設(shè)置封送拆收器在 DLL 中查找的名稱。設(shè)置此屬性后，您可以將 C# 函數(shù)重新命名為任何名稱。
ExactSpelling
將此屬性設(shè)置為 true，封送拆收器將關(guān)閉 A 和 W 的查找特性。
PreserveSig
COM 互操作使得具有最終輸出參數(shù)的函數(shù)看起來是由它返回的該值。此屬性用于關(guān)閉這一特性。
SetLastError
確保調(diào)用 Win32 API SetLastError()，以便您找出發(fā)生的錯(cuò)誤。
StructLayout
LayoutKind
結(jié)構(gòu)在默認(rèn)情況下按順序布局，并且在多數(shù)情況下都適用。如果需要完全控制結(jié)構(gòu)成員所放置的位置，可以使用 LayoutKind.Explicit，然后為每個(gè)結(jié)構(gòu)成員添加 FieldOffset 屬性。當(dāng)您需要?jiǎng)?chuàng)建 union 時(shí)，通常需要這樣做。
CharSet
控制 ByValTStr 成員的默認(rèn)字符類型。
Pack
設(shè)置結(jié)構(gòu)的壓縮大小。它控制結(jié)構(gòu)的排列方式。如果 C 結(jié)構(gòu)采用了其他壓縮方式，您可能需要設(shè)置此屬性。
Size
設(shè)置結(jié)構(gòu)大小。不常用；但是如果需要在結(jié)構(gòu)末尾分配額外的空間，則可能會(huì)用到此屬性。
從不同位置加載
您無法指定希望 DLLImport 在運(yùn)行時(shí)從何處查找文件，但是可以利用一個(gè)技巧來達(dá)到這一目的。
DllImport 調(diào)用 LoadLibrary() 來完成它的工作。如果進(jìn)程中已經(jīng)加載了特定的 DLL，那么即使指定的加載路徑不同，LoadLibrary() 也會(huì)成功。
這意味著如果直接調(diào)用 LoadLibrary()，您就可以從任何位置加載 DLL，然后 DllImport LoadLibrary() 將使用該 DLL。
由于這種行為，我們可以提前調(diào)用 LoadLibrary()，從而將您的調(diào)用指向其他 DLL。如果您在編寫庫，可以通過調(diào)用 GetModuleHandle() 來防止出現(xiàn)這種情況，以確保在首次調(diào)用 P/Invoke 之前沒有加載該庫。
P/Invoke 疑難解答
如果您的 P/Invoke 調(diào)用失敗，通常是因?yàn)槟承╊愋偷亩x不正確。以下是幾個(gè)常見問題：
1.long != long。在 C++ 中，long 是 4 字節(jié)的整數(shù)，但在 C# 中，它是 8 字節(jié)的整數(shù)。
2.字符串類型設(shè)置不正確。