在Net Framework SDK文档中关于调用Windows API的指示比较零散并且其中稍全面一点的是针对Visual 讲述的本文将C#中调用API的要点汇集如下希望给未在C#中使用过API的朋友一点帮助另外如果安装了Visual 的话在C:\Program Files\Microsoft Visual Studio NET\FrameworkSDK\Samples\Technologies\Interop\PlatformInvoke\WinAPIs\CS目录下有大量的调用API的例子
一调用格式
using SystemRuntimeInteropServices; //引用此名称空间简化后面的代码
//使用DllImportAttribute特性来引入api函数注意声明的是空方法即方法体为空
[DllImport(userdll)]
public static extern ReturnType FunctionName(type argtype arg);
//调用时与调用其他方法并无区别
可以使用字段进一步说明特性用逗号隔开如
[ DllImport( kernel EntryPoint=GetVersionEx )]
DllImportAttribute特性的公共字段如下
CallingConvention 指示向非托管实现传递方法参数时所用的 CallingConvention 值
CallingConventionCdecl : 调用方清理堆栈它使您能够调用具有 varargs 的函数
CallingConventionStdCall : 被调用方清理堆栈它是从托管代码调用非托管函数的默认约定
CharSet 控制调用函数的名称版本及指示如何向方法封送 String 参数
此字段被设置为 CharSet 值之一如果 CharSet 字段设置为 Unicode则所有字符串参数在传递到非托管实现之前都转换成 Unicode 字符这还导致向 DLL EntryPoint 的名称中追加字母W如果此字段设置为 Ansi则字符串将转换成 ANSI 字符串同时向 DLL EntryPoint 的名称中追加字母A大多数 Win API 使用这种追加W或A的约定如果 CharSet 设置为 Auto则这种转换就是与平台有关的（在 Windows NT 上为 Unicode在 Windows 上为 Ansi）CharSet 的默认值为 AnsiCharSet 字段也用于确定将从指定的 DLL 导入哪个版本的函数CharSetAnsi 和 CharSetUnicode 的名称匹配规则大不相同
对于 Ansi 来说如果将 EntryPoint 设置为MyMethod且它存在的话则返回MyMethod如果 DLL 中没有MyMethod但存在MyMethodA则返回MyMethodA对于 Unicode 来说则正好相反如果将 EntryPoint 设置为MyMethod且它存在的话则返回MyMethodW如果 DLL 中不存在MyMethodW但存在MyMethod则返回MyMethod如果使用的是 Auto则匹配规则与平台有关（在 Windows NT 上为 Unicode在 Windows 上为 Ansi）如果 ExactSpelling 设置为 true则只有当 DLL 中存在MyMethod时才返回MyMethod
EntryPoint 指示要调用的 DLL 入口点的名称或序号
如果你的方法名不想与api函数同名的话一定要指定此参数例如
[DllImport(userdllCharSet=CharSetAutoEntryPoint=MessageBox)]
public static extern int MsgBox(IntPtr hWndstring txtstring caption int type);
ExactSpelling 指示是否应修改非托管 DLL 中的入口点的名称以与 CharSet 字段中指定的 CharSet 值相对应如果为 true则当 DllImportAttributeCharSet 字段设置为 CharSet 的 Ansi 值时向方法名称中追加字母 A当 DllImportAttributeCharSet 字段设置为 CharSet 的 Unicode 值时向方法的名称中追加字母 W此字段的默认值是 false
PreserveSig 指示托管方法签名不应转换成返回 HRESULT并且可能有一个对应于返回值的附加 [out retval] 参数的非托管签名
SetLastError 指示被调用方在从属性化方法返回之前将调用 Win API SetLastError true 指示调用方将调用 SetLastError默认为 false运行时封送拆收器将调用 GetLastError 并缓存返回的值以防其被其他 API 调用重写用户可通过调用 GetLastWinError 来检索错误代码
二参数类型
数值型直接用对应的就可（DWORD > int WORD > Int）
API中字符串指针类型 >中string
API中句柄 (dWord) >中IntPtr
API中结构 >中结构或者类注意这种情况下要先用StructLayout特性限定声明结构或类
公共语言运行库利用StructLayoutAttribute控制类或结构的数据字段在托管内存中的物理布局即类或结构需要按某种方式排列如果要将类传递给需要指定布局的非托管代码则显式控制类布局是重要的它的构造函数中用LayoutKind值初始化 StructLayoutAttribute 类的新实例 LayoutKindSequential 用于强制将成员按其出现的顺序进行顺序布局
LayoutKindExplicit 用于控制每个数据成员的精确位置利用 Explicit 每个成员必须使用 FieldOffsetAttribute 指示此字段在类型中的位置如
[StructLayout(LayoutKindExplicit Size= CharSet=CharSetAnsi)]
public class MySystemTime
{
[FieldOffset()]public ushort wYear;
[FieldOffset()]public ushort wMonth;
[FieldOffset()]public ushort wDayOfWeek;
[FieldOffset()]public ushort wDay;
[FieldOffset()]public ushort wHour;
[FieldOffset()]public ushort wMinute;
[FieldOffset()]public ushort wSecond;
[FieldOffset()]public ushort wMilliseconds;
}
下面是针对API中OSVERSIONINFO结构中定义对应类或结构的例子
/**********************************************
* API中定义原结构声明
* OSVERSIONINFOA STRUCT
* dwOSVersionInfoSize DWORD ?
* dwMajorVersion DWORD ?
* dwMinorVersion DWORD ?
* dwBuildNumber DWORD ?
* dwPlatformId DWORD ?
* szCSDVersion BYTE dup (?)
* OSVERSIONINFOA ENDS
*
* OSVERSIONINFO equ *********************************************/
/中声明为类
[ StructLayout( LayoutKindSequential )]
public class OSVersionInfo
{
public int OSVersionInfoSize;
public int majorVersion;
public int minorVersion;
public int buildNumber;
public int platformId;
[ MarshalAs( UnmanagedTypeByValTStr SizeConst= )]
public String versionString;
}
//或者
/中声明为结构
[ StructLayout( LayoutKindSequential )]
public struct OSVersionInfo
{
public int OSVersionInfoSize;
public int majorVersion;
public int minorVersion;
public int buildNumber;
public int platformId;
[ MarshalAs( UnmanagedTypeByValTStr SizeConst= )]
public String versionString;
}
此例中用到MashalAs特性它用于描述字段方法或参数的封送处理格式用它作为参数前缀并指定目标需要的数据类型例如以下代码将两个参数作为数据类型长指针封送给 Windows API 函数的字符串 (LPStr)
[MarshalAs(UnmanagedTypeLPStr)]
String existingfile;
[MarshalAs(UnmanagedTypeLPStr)]
String newfile;
注意结构作为参数时候一般前面要加上ref修饰符否则会出现错误对象的引用没有指定对象的实例
[ DllImport( kernel EntryPoint=GetVersionEx )]
public static extern bool GetVersionEx( ref OSVersionInfo osvi );
三如何保证使用托管对象的平台调用成功？
如果在调用平台 invoke 后的任何位置都未引用托管对象则垃圾回收器可能将完成该托管对象这将释放资源并使句柄无效从而导致平台invoke 调用失败用 HandleRef 包装句柄可保证在平台 invoke 调用完成前不对托管对象进行垃圾回收
例如下面
FileStream fs = new FileStream( atxt FileModeOpen );
StringBuilder buffer = new StringBuilder( );
int read = ;
ReadFile(fsHandle buffer out read ); //调用Win API中的ReadFile函数
由于fs是托管对象所以有可能在平台调用还未完成时候被垃圾回收站回收将文件流的句柄用HandleRef包装后就能避免被垃圾站回收:
[ DllImport( Kerneldll )]
public static extern bool ReadFile(
HandleRef hndRef
StringBuilder buffer
int numberOfBytesToRead
out int numberOfBytesRead
ref Overlapped flag );
FileStream fs = new FileStream( HandleReftxt FileModeOpen );
HandleRef hr = new HandleRef( fs fsHandle );
StringBuilder buffer = new StringBuilder( );
int read = ;
// platform invoke will hold reference to HandleRef until call ends
ReadFile( hr buffer out read );
