Win32 API PInvoke

PInvoke什么意思？ Platform Invocation Services

 

以下两篇文章阐述了在C#中使用Win32API的细节

 

Visual C#中调用Windows API的要点

http://www.cnblogs.com/showna/articles/869295.html

 

在 C# 中通过 P-Invoke 调用Win32 DLL

http://msdn.microsoft.com/zh-cn/library/aa686045.aspx

 

注意，DllImport必须放在类定义中，一个DllImport对应一个API声明

 

MSDN - Windows API Reference

http://msdn.microsoft.com/en-us/library/aa383749(VS.85).aspx

 

推荐几个辅助.cs文件和工具

 

api.cs (C# API)

http://download.csdn.net/source/511344

 

大量常用Win32 API的C#声明（API函数、结构体和常数声明）

http://www.codefans.net/soft/1880.shtml

 

API精灵 for C#

http://download.csdn.net/source/644635

 

API 常量查询器

http://download.csdn.net/source/967181

 

 一个CHM格式的Windows API参考

http://www.netyi.net/Book/ace90888-7659-476f-be89-b22fc0b3919f.htm

 

推荐使用第一个api.cs，并逐步完善它

 

在文章结束前找到了一个绝好的站点http://www.pinvoke.net/

pinvoke是一个win32 api for .net wiki 上面有绝大多数api及相关数据结构、常量和枚举的C#和VB.NET定义，还包括了API调用的代码范例，而且pinvoki还提供了一个free的VS插件 PInvoke.net Add-in 通过它可以更方便的在.net开发环境中使用api，唯一的缺撼就是对于api的查询结果中只提供了api声明的定义，相关数据结构、常量和枚举需要单独查询，出得的结果也只是相关的pinvoke.net链接。

 

当然pinvoke.net也不是完美的，由于定义由网友提交，因此有些定义并不规范，最常见的就是参数类型的定义可能跟MSDN的时常有些出入，这个问题可以参考：

 

C#中调用Windows API时的数据类型对应关系

http://www.cnblogs.com/madyina/articles/864059.html

 

建议使用在项目中使用一个单独的cs文件存放所有Win32 API的声明及相关定义

 

Win32API.cs

namespace YouApplicationName{ #region 数据结构定义 [StructLayout(LayoutKind.Sequential, CharSet = CharSet.Ansi)] public struct IP_ADAPTER_INFO { public IntPtr Next; public Int32 ComboIndex; [MarshalAs(UnmanagedType.ByValTStr, SizeConst = ApiConst.MAX_ADAPTER_NAME_LENGTH + 4)] public string AdapterName; [MarshalAs(UnmanagedType.ByValTStr, SizeConst = ApiConst.MAX_ADAPTER_DESCRIPTION_LENGTH + 4)] public string AdapterDescription; public UInt32 AddressLength; [MarshalAs(UnmanagedType.ByValArray, SizeConst = ApiConst.MAX_ADAPTER_ADDRESS_LENGTH)] public byte[] Address; public Int32 Index; public UInt32 Type; public UInt32 DhcpEnabled; public IntPtr CurrentIpAddress; public IP_ADDR_STRING IpAddressList; public IP_ADDR_STRING GatewayList; public IP_ADDR_STRING DhcpServer; public bool HaveWins; public IP_ADDR_STRING PrimaryWinsServer; public IP_ADDR_STRING SecondaryWinsServer; public Int32 LeaseObtained; public Int32 LeaseExpires; } [StructLayout(LayoutKind.Sequential, CharSet = CharSet.Ansi)] public struct IP_ADDR_STRING { public IntPtr Next; public IP_ADDRESS_STRING IpAddress; public IP_ADDRESS_STRING IpMask; public Int32 Context; } [StructLayout(LayoutKind.Sequential, CharSet = CharSet.Ansi)] public struct IP_ADDRESS_STRING { [MarshalAs(UnmanagedType.ByValTStr, SizeConst = 16)] public string Address; } [StructLayout(LayoutKind.Sequential, CharSet = CharSet.Auto)] struct RASENTRYNAME { public int dwSize; [MarshalAs(UnmanagedType.ByValTStr, SizeConst = ApiConst.RAS_MaxEntryName + 1)] public string szEntryName; public int dwFlags; [MarshalAs(UnmanagedType.ByValTStr, SizeConst = ApiConst.MAX_PATH + 1)] public string szPhonebook; } #endregion #region 常量定义 class ApiConst { #region MAX_ADAPTER public const int MAX_ADAPTER_ADDRESS_LENGTH = 8; public const int MAX_ADAPTER_DESCRIPTION_LENGTH = 128; public const int MAX_ADAPTER_NAME_LENGTH = 256; #endregion #region MAX public const int MAX_PATH = 260; #endregion #region RAS public const int RAS_MaxEntryName = 256; #endregion } #endregion #region 枚举定义 #endregion #region API定义 class API { #region GetAdapterInfo [DllImport("iphlpapi.dll", CharSet = CharSet.Ansi)] public static extern int GetAdaptersInfo(IntPtr pAdapterInfo, ref Int64 pBufOutLen); #endregion GetAdapterInfo #region RasEnumEntries [DllImport("rasapi32.dll", SetLastError = true, CharSet = CharSet.Auto)] public static extern uint RasEnumEntries( IntPtr reserved, IntPtr lpszPhonebook, [In, Out] RASENTRYNAME[] lprasentryname, ref int lpcb, ref int lpcEntries); #endregion } #endregion}  

  以上代码是从api.cs改进而来，将以上代码复制到VS中，查看效果

1、用四个region块，括起数据类型定义struct、常量定义const、枚举定义enum及API声明

2、为简化代码输入，struct、const、enum定义不放入class api中

3、每个region块与中间内容留出一空行，但最内层的region除外

4、为相关const定义增加region块哪#region MAX_ADAPTER，但struct不需要，因为struct定义本身就具有收缩功能

...

可以维护这样一个cs文件，在项目中使用和完善它，项目结束后单独保存出来

 

 

以下是一个PInvoke.net中关于GetAdapterInfo调用的范例代码的简化版

//参考:http://www.pinvoke.net/default.aspx/iphlpapi/GetAdaptersInfo.html //分配非托管内存 long structSize = Marshal.SizeOf(typeof(IP_ADAPTER_INFO)); IntPtr pArray = Marshal.AllocHGlobal(new IntPtr(structSize)); //第一次调用 int ret = API.GetAdaptersInfo(pArray, ref structSize); //判断所分配内存是否太小 if (ret == ApiConst.ERROR_BUFFER_OVERFLOW) { //根据structSize所指示的大小重新分配内存 pArray = Marshal.ReAllocHGlobal(pArray, new IntPtr(structSize)); //重新调用 ret = API.GetAdaptersInfo(pArray, ref structSize); } //调用成功 if (ret == ERROR_SUCCESS)//ERROR_SUCCESS = 0 { //获取内存块指针 IntPtr pEntry = pArray; // do { //将数据从非托管内存块重新封送到新分配的指定类型的托管对象 IP_ADAPTER_INFO entry = (IP_ADAPTER_INFO)Marshal.PtrToStructure(pEntry, typeof(IP_ADAPTER_INFO)); //拼接并格式化MAC地址 string tmpStr = string.Empty; for (int i = 0; i < entry.AddressLength - 1; i++) { tmpStr += string.Format("{0:X2}-", entry.Address[i]); } tmpStr = string.Format("{0}{1:X2}", tmpStr, entry.Address[entry.AddressLength - 1]); //显示网卡描述及MAC地址 Trace.WriteLine(entry.AdapterDescription + ":" + tmpStr); //取得下一个结构的内存指针 pEntry = entry.Next; } while (pEntry != IntPtr.Zero); //释放内存 Marshal.FreeHGlobal(pArray); } else //调用失败 { //释放内存并抛出一个异常 Marshal.FreeHGlobal(pArray); throw new InvalidOperationException("GetAdaptersInfo failed:" + ret); }

通过以上代码可以了解一种生疏了的api调用方式(分配堆-调用-根据返回大小重新分配-再调用)、Marshal的使用、非托管内存到托管内存的转换等操作等

 

以下是PInvoke.net中关于GetRasEnumEntries调用的范例代码

//RASENTRYNAME数组-一个成员 RASENTRYNAME[] entryNames = new RASENTRYNAME[1]; //设置RASENTRYNAME结构的dwSize entryNames[0].dwSize = Marshal.SizeOf(typeof(RASENTRYNAME)); //设置cb，它一个[in, out]参数，用于向API输入和由API输出实际的缓冲区大小 int cb = 1 * Marshal.SizeOf(typeof(RASENTRYNAME)); //[in, out] //由API返回获取的数据条目数，它是一个[out]输出参数 int entries = 0; //[out] //第一次调用 uint nRet = API.RasEnumEntries(IntPtr.Zero, IntPtr.Zero, entryNames, ref cb, ref entries); //这里不能使用nRet != ERROR_SUCCESS 这里对于系统中存在一个拨号连接以上的情况，nRet是ERROR_BUFFER_TOO_SMALL if (entries == 0) return; //根据entries定义新数组并调用API if (entries > 1) { entryNames = new RASENTRYNAME[entries]; for (int i = 0; i < entries; i++) entryNames[i].dwSize = Marshal.SizeOf(typeof(RASENTRYNAME)); nRet = API.RasEnumEntries(IntPtr.Zero, IntPtr.Zero, entryNames, ref cb, ref entries); } //输出 for (int i = 0; i < entries; i++) Trace.WriteLine(entryNames[i].szEntryName);

以上代码说明了变长数组的api调用方式，以及dwSize，cb，entries的使用

 

最后有一点需要提醒，虽然使用PInvoke可以调用Win32API，但这是需要牺牲一些运行时性能的，所以如果有对应的Managed API的话，还是建议选用Managed API。