平台调用服务_科中资源网

平台调用服务通常指微软的公共语言运行时提供的跨平台调用方式。平台调用服务是公共语言基础设施相关实现的一个特性。这一特性与微软的公共语言运行时提供的较为类似，因此一般提到P/Invoke多数指微软的.NET实现方案。这一方案能够实现通过託管代码访问原生代码。使用P/Invoke可以通过CLR来控制DLL的载入，以及将非託管代码的数据类型转换为託管数据类型。

基本介绍

中文名：平台调用服务
外文名：Platform Invocation Service
简称：P/Invoke

简介

在Microsoft Windows作业系统中，Native API有时也是以COM接口方式来推出，像是ADSI，FSRM（File Server Resource Manager）等，通常是新的服务或是接口才会广泛使用COM原生接口方式。因为.NET Framework的推行，Windows的应用程式接口被分为两种，一种是遵循原本Windows API方式的，称为Native API，另一种则是以.NET Framework为基础开发的，称为Managed API，例如Managed DirectX或是IIS Admin APIs等。

在Microsoft Windows作业系统中，若是通过VB或是.NET Framework访问直接开放C函式的Native API时，则必须要利用平台调用服务方式访问；若是访问以COM方式开放的Native API时，若该API支持COM Automation规格时，即可利用COM Interop Services来访问。

在受控代码与非受控代码进行互动时会产生一个事务（transition），这通常发生在使用平台调用服务（Platform Invocation Services），即P/Invoke平台调用是一种服务，它使託管代码能够调用 DLL 中实现的非託管函式。如调用系统的 API 或与 COM 对象打交道，通过 System.Runtime.InteropServices 命名空间。为了从託管代码中调用非託管的DLL中函式，你要创建一个P/Invoke包装（Wrapper)。一个P/Invoke包装是一个.net兼容的方法声明，用来创建P/Invoke包装的语法与创建託管方法的声明语法本质上是一样的。一个不同点是P/Invoke包装不包含函式体，而只有方法名、返回值类型和参数信息。并且，P/Invoke包装使用了DllImport属性。这个属性是用来定位包含有目标函式的非託管的DLL。

例如：MessageBox在win32的头档案中的声明：int WINAPI MessageBoxA(HWnd,LPCWSTR lpText,LPCWSTR lpCaption,UINT uType);那幺要在C#中调用这个MessageBox时要这样声明：

using System.Runtime.InteropServices; public class Win32 { [DllImport("user32.dll")] public static extern int MessageBox(int hWnd, String text, String caption, uint type); }

然后可以用常规的.net方法去调用这个MessageBox：

public class HelloWorld { public static void Main() { Win32.MessageBox(0, "Hello World", "Platform Invoke Sample", 0); } }

C#中的平台调用

调用格式

using System.Runtime.InteropServices; //引用此名称空间，简化后面的代码...//使用DllImportAttribute特性来引入api函式，注意声明的是空方法，即方法体为空。[DllImport("user32.dll")]public static extern ReturnType FunctionName(type arg1,type arg2,...);//调用时与调用其他方法并无区别

可以使用栏位进一步说明特性，用逗号隔开，如：

[ DllImport( "kernel32", EntryPoint="GetVersionEx" )]

DllImportAttribute特性的公共栏位如下：
1、CallingConvention 指示向非託管实现传递方法参数时所用的 CallingConvention 值。
CallingConvention.Cdecl : 调用方清理堆叠。它使您能够调用具有 varargs 的函式。
CallingConvention.StdCall : 被调用方清理堆叠。它是从託管代码调用非託管函式的默认约定。
2、CharSet 控制调用函式的名称版本及指示如何向方法封送 String 参数。
此栏位被设定为 CharSet 值之一。如果 CharSet 栏位设定为 Unicode，则所有字元串参数在传递到非託管实现之前都转换成 Unicode 字元。这还导致向 DLL EntryPoint 的名称中追加字母“W”。如果此栏位设定为 Ansi，则字元串将转换成 ANSI 字元串，同时向 DLL EntryPoint 的名称中追加字母“A”。大多数 Win32 API 使用这种追加“W”或“A”的约定。如果 CharSet 设定为 Auto，则这种转换就是与平台有关的（在 Windows NT 上为 Unicode，在 Windows 98 上为 Ansi）。CharSet 的默认值为 Ansi。CharSet 栏位也用于确定将从指定的 DLL 导入哪个版本的函式。CharSet.Ansi 和 CharSet.Unicode 的名称匹配规则大不相同。
对于 Ansi 来说，如果将 EntryPoint 设定为“MyMethod”且它存在的话，则返回“MyMethod”。如果 DLL 中没有“MyMethod”，但存在“MyMethodA”，则返回“MyMethodA”。对于 Unicode 来说则正好相反。如果将 EntryPoint 设定为“MyMethod”且它存在的话，则返回“MyMethodW”。如果 DLL 中不存在“MyMethodW”，但存在“MyMethod”，则返回“MyMethod”。如果使用的是 Auto，则匹配规则与平台有关（在 Windows NT 上为 Unicode，在 Windows 98 上为 Ansi）。如果 ExactSpelling 设定为 true，则只有当 DLL 中存在“MyMethod”时才返回“MyMethod”。

3、EntryPoint 指示要调用的 DLL 入口点的名称或序号。
如果你的方法名不想与api函式同名的话，一定要指定此参数,例如：

[DllImport("user32.dll",CharSet="CharSet.Auto",EntryPoint="MessageBox")]public static extern int MsgBox(IntPtr hWnd,string txt,string caption, int type);

4、ExactSpelling 指示是否应修改非託管 DLL 中的入口点的名称，以与 CharSet 栏位中指定的 CharSet 值相对应。如果为 true，则当 DllImportAttribute.CharSet 栏位设定为 CharSet 的 Ansi 值时，向方法名称中追加字母 A，当 DllImportAttribute.CharSet 栏位设定为 CharSet 的 Unicode 值时，向方法的名称中追加字母 W。此栏位的默认值是 false。
5、PreserveSig 指示託管方法签名不应转换成返回 HRESULT、并且可能有一个对应于返回值的附加 [out, retval] 参数的非託管签名。
6、SetLastError 指示被调用方在从属性化方法返回之前将调用 Win32 API SetLastError。 true 指示调用方将调用 SetLastError，默认为 false。运行时封送拆收器将调用 GetLastError 并快取返回的值，以防其被其他 API 调用重写。用户可通过调用 GetLastWin32Error 来检索错误代码。

参数类型

1、数值型直接用对应的就可。（DWORD -> int , WORD -> Int16）
2、API中字元串指针类型 -> .net中string
3、API中句柄 (dWord) -> .net中IntPtr
4、API中结构 -> .net中结构或者类。注意这种情况下，要先用StructLayout特性限定声明结构或类
公共语言运行库利用StructLayoutAttribute控制类或结构的数据栏位在託管记忆体中的物理布局,即类或结构需要按某种方式排列。如果要将类传递给需要指定布局的非託管代码，则显式控制类布局是重要的。它的构造函式中用LayoutKind值初始化 StructLayoutAttribute 类的新实例。 LayoutKind.Sequential 用于强制将成员按其出现的顺序进行顺序布局。
LayoutKind.Explicit 用于控制每个数据成员的精确位置。利用 Explicit，每个成员必须使用 FieldOffsetAttribute 指示此栏位在类型中的位置。如：

[StructLayout(LayoutKind.Explicit, Size=16, CharSet=CharSet.Ansi)]public class MySystemTime {[FieldOffset(0)]public ushort wYear; [FieldOffset(2)]public ushort wMonth;[FieldOffset(4)]public ushort wDayOfWeek; [FieldOffset(6)]public ushort wDay; [FieldOffset(8)]public ushort wHour; [FieldOffset(10)]public ushort wMinute; [FieldOffset(12)]public ushort wSecond; [FieldOffset(14)]public ushort wMilliseconds; }

下面是针对API中OSVERSIONINFO结构，在.net中定义对应类或结构的例子：

/*********************************************** API中定义原结构声明* OSVERSIONINFOA STRUCT* dwOSVersionInfoSize DWORD ?* dwMajorVersion DWORD ?* dwMinorVersion DWORD ?* dwBuildNumber DWORD ?* dwPlatformId DWORD ?* szCSDVersion BYTE 128 dup (?)* OSVERSIONINFOA ENDS** OSVERSIONINFO equ <OSVERSIONINFOA>*********************************************///.net中声明为类[ StructLayout( LayoutKind.Sequential )] public class OSVersionInfo { public int OSVersionInfoSize;public int majorVersion; public int minorVersion;public int buildNumber;public int platformId;[ MarshalAs( UnmanagedType.ByValTStr, SizeConst=128 )] public String versionString;}//或者//.net中声明为结构[ StructLayout( LayoutKind.Sequential )] public struct OSVersionInfo2 {public int OSVersionInfoSize;public int majorVersion; public int minorVersion;public int buildNumber;public int platformId;[ MarshalAs( UnmanagedType.ByValTStr, SizeConst=128 )] public String versionString;}

此例中用到MashalAs特性，它用于描述栏位、方法或参数的封送处理格式。用它作为参数前缀并指定目标需要的数据类型。例如，以下代码将两个参数作为数据类型长指针封送给 Windows API 函式的字元串 (LPStr)：

[MarshalAs(UnmanagedType.LPStr)]String existingfile;[MarshalAs(UnmanagedType.LPStr)]String newfile;

注意结构作为参数时候，一般前面要加上ref修饰符，否则会出现错误：对象的引用没有指定对象的实例。

[ DllImport( "kernel32", EntryPoint="GetVersionEx" )] public static extern bool GetVersionEx2( ref OSVersionInfo2 osvi );

如何保证使用託管对象的平台调用成功

如果在调用平台 invoke 后的任何位置都未引用託管对象，则垃圾回收器可能将完成该託管对象。这将释放资源并使句柄无效，从而导致平台invoke 调用失败。用 HandleRef 包装句柄可保证在平台 invoke 调用完成前，不对託管对象进行垃圾回收。

例如下面：

FileStream fs = new FileStream( "a.txt", FileMode.Open );StringBuilder buffer = new StringBuilder( 5 );int read = 0;ReadFile(fs.Handle, buffer, 5, out read, 0 ); //调用Win API中的ReadFile函式

由于fs是託管对象，所以有可能在平台调用还未完成时候被垃圾资源回收筒回收。将档案流的句柄用HandleRef包装后，就能避免被垃圾站回收:

[ DllImport( "Kernel32.dll" )]public static extern bool ReadFile( HandleRef hndRef, StringBuilder buffer, int numberOfBytesToRead, out int numberOfBytesRead, ref Overlapped flag );............FileStream fs = new FileStream( "HandleRef.txt", FileMode.Open );HandleRef hr = new HandleRef( fs, fs.Handle );StringBuilder buffer = new StringBuilder( 5 );int read = 0;// platform invoke will hold reference to HandleRef until call endsReadFile( hr, buffer, 5, out read, 0 );