網站運營seo文章大全提供全面的站長運營經驗及seo技術!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;
在 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.字符串類型設置不正確。