C# 调用API -炒冷饭系列

阳历今年的最后一天了,又该干点什么。 小鬼职业病又来了"神情恍惚，目光呆滞的敲着键盘，陶醉的望着跳动的光标，嘴角上扬。"

 最近项目中用到C#调用第三方提供的动态链接库 就是DLL 中API。

这也是VB6.0的时代就有如何调用Window API了，点选API Viewer 查询相关API点选两下就可以生成方法的签名 （声明函数）  用方法签名 + 参数就可 直接调用了。

C#刚开始没有提供相关类是API Viewer; 在自己动手，丰衣足食的年代，就手写写吧。这也无可厚非的做法，但是手写要知道API的方法签名才行。还有许多的类型替换和构造;宽字符怎样正确的调用API得到我们想要的的结果。

用C的和用ASM的同仁调用API就是像呼吸一样简单。小鬼就没法想象了。

　　C# 调用API是件麻烦的事 

int WINAPI MessageBox(
  __in_opt  HWND hWnd,
  __in_opt  LPCTSTR lpText,
  __in_opt  LPCTSTR lpCaption,
  __in      UINT uType
);

具体介绍这个API

这是声明API的全方法签名 但run不了。为了看看繁琐 特性描述而已

 

　　好在可以缺省部分参数是个不错特性 

        [DllImport("user32.dll")]
        public static extern IntPtr MessageBox(
                                IntPtr hWnd,
                                String lpText,
                                String lpCaption,
                                uint uType);

        static void Main(string[] args)
        {
            MessageBox(IntPtr.Zero, "Hello world", "Hello world!", 1u);
        }

好的这就是一个最简单API调用了。接下来就可以一步步来了

 

 但遇到更复杂API 就有点迷茫了

BOOL PtInRect(
  __in  const RECT *lprc,
  __in  POINT pt
);

  具体介绍这个API

 RECT 是什么？

 Point 是什么？

 ... 

这些问题 以前让小鬼迷茫； 将来让小鬼迷离；现在让小鬼着迷。 对照了API和查阅一些文章　（有些作者不详　知道告诉我一声　我会加链接的）

  　　[StructLayout(LayoutKind.Sequential)]
        public struct Point
        {
            public int x;
            public int y;
        }
        [StructLayout(LayoutKind.Explicit)]
        public struct Rect
        {
            [FieldOffset(0)]
            public int left;
            [FieldOffset(4)]
            public int top;
            [FieldOffset(8)]
            public int right;
            [FieldOffset(12)]
            public int bottom;
        }

        [DllImport("User32.dll")]
        public static extern bool PtInRect(ref Rect r, Point p);

这样的API签名就可以调用了。

　C# API 有什么讲究 

调用API还是Winform项目用得多。  

 Api 函数是构筑Windws 应用程序的基石，每一种Windows 应用程序开发工具，它提供的底层函数都间接或直接地调用了Windows API 函数，同时为了实现功能扩展，一般也都提供了调用WindowsAPI 函数的接口， 也就是说具备调用动态连接库的能力。Visual C#和其它开发工具一样也能够调用动态链接库的API 函数。.NET 框架本身提供了这样一种服务,允许受管辖的代码调用动态链接库中实现的非受管辖函数,包括操作系统提供的Windows API 函数。它能够定位和调用输出函数,根据需要，组织其各个参数(整型、字符串类型、数组、和结构等等)跨越互操作边界。

   C# 调用API基本步骤

 C#对动态链接库函数声明部分一般由下列两部分组成，一是函数名或索引号，二是动态链接库的文件名。

譬如，你想调用User32.DLL 中的MessageBox 函数，我们必须指明函数的名字MessageBoxA 或MessageBoxW，以及库名字User32.dll,我们知道Win32 API 对每一个涉及字符串和字符的函数一般都存在两个版本，单字节字符的ANSI 版本和双字节字符的UNICODE 版本。

 

[DllImport("KERNEL32.DLL", 
            EntryPoint = "MoveFileW", SetLastError = true,
            CharSet = CharSet.Unicode, ExactSpelling = true,
            CallingConvention = CallingConvention.StdCall)]
public static extern bool MoveFile(String src, String dst);

其中入口点EntryPoint 标识函数在动态链接库的入口位置，在一个受管辖的工程中，目标函数的原始  名字和序号入口点不仅标识一个跨越互操作界限的函数。而且，你还可以把这个入口点映射为一个不同 的名字，也就是对函数进行重命名。重命名可以给调用函数带来种种便利，通过重命名，一方面我们不 用为函数的大小写伤透脑筋，同时它也可以保证与已有的命名规则保持一致，允许带有不同参数类型的 函数共存，更重要的是它简化了对ANSI 和Unicode 版本的调用。CharSet 用于标识函数调用所采用的 是Unicode 或是ANSI 版本，ExactSpelling＝false 将告诉编译器,让编译器决定使用Unicode 或者是Ansi 版本。其它的参数请参考MSDN 在线帮助.  在C#中，你可以在EntryPoint 域通过名字和序号声明一个动态链接库函数，如果在方法定义中使用的 函数名与DLL 入口点相同，你不需要在EntryPoint 域显示声明函数。否则，你必须使用下列属性格式指 示一个名字和序号。

 

[DllImport("dllname", EntryPoint="Functionname")]
[DllImport("dllname", EntryPoint="#123")]
值得注意的是，你必须在数字序号前加“＃”

下面是一个用MsgBox 替换MessageBox 名字的例子：

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

 

许多受管辖的动态链接库函数期望你能够传递一个复杂的参数类型给函数，譬如一个用户定义的结构类型成员或者受管辖代码定义的一个类成员，这时你必须提供额外的信息格式化这个类型，以保持参数原有的布局和对齐。 

C#提供了一个StructLayoutAttribute 类，通过它你可以定义自己的格式化类型，在受管辖代码中，格式化类型是一个用StructLayoutAttribute 说明的结构或类成员，通过它能够保证其内部成员预期的布局信息。布局的选项共有三种：
布局选项
描述
LayoutKind.Automatic
为了提高效率允许运行态对类型成员重新排序。
注意：永远不要使用这个选项来调用不受管辖的动态链接库函数。

LayoutKind.Explicit
对每个域按照FieldOffset 属性对类型成员排序

LayoutKind.Sequential
对出现在受管辖类型定义地方的不受管辖内存中的类型成员进行排序。

 

传递结构成员

下面的例子说明如何在受管辖代码中定义一个点和矩形类型，并作为一个参数传递给User32.dll 库中的
PtInRect 函数，
函数的不受管辖原型声明如下：
BOOL PtInRect(const RECT *lprc, POINT pt);
注意你必须通过引用传递Rect 结构参数，因为函数需要一个Rect 的结构指针。

        [StructLayout(LayoutKind.Sequential)]
　　　　 public struct Point
        {
　　　　　　public int x;　　
　　　　　　public int y;
        }
        [StructLayout(LayoutKind.Explicit)]
　　　　　public struct Rect
        {
            [FieldOffset(0)]
　　　　　　public int left;
            [FieldOffset(4)]
　　　　　　public int top;
            [FieldOffset(8)]
　　　　　　public int right;
            [FieldOffset(12)]
　　　　　　public int bottom;
        }
[DllImport("User32.dll")]
public static extern bool PtInRect(ref Rect r, Point p);

 

  类似你可以调用GetSystemInfo 函数获得系统信息：

[StructLayout(LayoutKind.Sequential)]
public struct SYSTEM_INFO {
public uint dwOemId;
public uint dwPageSize;
public uint lpMinimumApplicationAddress;
public uint lpMaximumApplicationAddress;
public uint dwActiveProcessorMask;
public uint dwNumberOfProcessors;
public uint dwProcessorType;
public uint dwAllocationGranularity;
public uint dwProcessorLevel;
public uint dwProcessorRevision;
}
[DllImport("kernel32.dll")]
staticexternvoid GetSystemInfo(ref SYSTEM_INFO pSI);

SYSTEM_INFO pSI = new SYSTEM_INFO();
GetSystemInfo(ref pSI);

类成员的传递

   同样只要类具有一个固定的类成员布局，你也可以传递一个类成员给一个不受管辖的动态链接库函数，
下面的例子主要说明如何传递一个sequential 顺序定义的MySystemTime 类给User32.dll 的GetSystem
Time 函数, 函数用C/C++调用规范如下:
void GetSystemTime(SYSTEMTIME* SystemTime);
不像传值类型,类总是通过引用传递参数.

 

[StructLayout(LayoutKind.Sequential)]
public class MySystemTime {
public ushort wYear;
public ushort wMonth;
public ushort wDayOfWeek;
public ushort wDay;
public ushort wHour;
public ushort wMinute;
public ushort wSecond;
public ushort wMilliseconds;
}
class Win32API {
[DllImport("User32.dll")]
public static extern void GetSystemTime(MySystemTime st);
}

 

回调函数的传递:

 

从受管辖的代码中调用大多数动态链接库函数,你只需创建一个受管辖的函数定义，然后调用它即可,这个
过程非常直接。
如果一个动态链接库函数需要一个函数指针作为参数，你还需要做以下几步：
首先，你必须参考有关这个函数的文档，确定这个函数是否需要一个回调；第二，你必须在受管辖代码
中创建一个回调函数；最后，你可以把指向这个函数的指针作为一个参数创递给DLL 函数,.
回调函数及其实现:
回调函数经常用在任务需要重复执行的场合,譬如用于枚举函数,譬如Win32 API 中的EnumFontFamilies
(字体枚举), EnumPrinters(打印机), EnumWindows (窗口枚举)函数. 下面以窗口枚举为例,谈谈如何通过
调用EnumWindow 函数遍历系统中存在的所有窗口
分下面几个步骤:
1. 在实现调用前先参考函数的声明
BOOL EnumWindows(WNDENUMPROC lpEnumFunc, LPARMAM IParam)
显然这个函数需要一个回调函数地址作为参数.
2. 创建一个受管辖的回调函数,这个例子声明为代表类型(delegate),也就是我们所说的回调,它带有两个参
数hwnd 和lparam,第一个参数是一个窗口句柄，第二个参数由应用程序定义，两个参数均为整形。
当这个回调函数返回一个非零值时，标示执行成功，零则暗示失败，这个例子总是返回True 值，以
便持续枚举。
3. 最后创建以代表对象(delegate)，并把它作为一个参数传递给EnumWindows 函数，平台会自动地 把
代表转化成函数能够识别的回调格式。

 

using System;
using System.Runtime.InteropServices;
public delegate bool CallBack(int hwnd, int lParam);
public class EnumReportApp {
[DllImport("user32")]
public static extern int EnumWindows(CallBack x, int y);
public static void Main()
{
　　CallBack myCallBack = new CallBack(EnumReportApp.Report);
　　EnumWindows(myCallBack, 0);
}
public static bool Report(int hwnd, int lParam) {
　　Console.Write("窗口句柄为");
　  Console.WriteLine(hwnd);
return true;
}
}

 

 

指针类型参数传递：

 在Windows API 函数调用时，大部分函数采用指针传递参数，对一个结构变量指针，我们除了使用上
面的类和结构方法传递参数之外，我们有时还可以采用数组传递参数。

下面这个函数通过调用GetUserName 获得用户名

BOOL GetUserName(
LPTSTR lpBuffer, // 用户名缓冲区
LPDWORD nSize // 存放缓冲区大小的地址指针
);

 

[DllImport("Advapi32.dll",
　　EntryPoint="GetComputerName",
　　ExactSpelling=false,
　　SetLastError=true)]
static extern bool GetComputerName (
　　[MarshalAs(UnmanagedType.LPArray)] byte[] lpBuffer,
　　[MarshalAs(UnmanagedType.LPArray)] Int32[] nSize );

 这个函数接受两个参数，char * 和int *,因为你必须分配一个字符串缓冲区以接受字符串指针，你可以
使用String 类代替这个参数类型，当然你还可以声明一个字节数组传递ANSI 字符串，同样你也可以声
明一个只有一个元素的长整型数组，使用数组名作为第二个参数。上面的函数可以调用如下：

 

byte[] str=new byte[20];
Int32[] len=new Int32[1];
len[0]=20;
GetComputerName (str,len);
MessageBox.Show(System.Text.Encoding.ASCII.GetString(str));

 

 

 最后需要提醒的是，每一种方法使用前必须在文件头加上：
using System.Runtime.InteropServices;

本来想给连接的的 但是好像找不到 这样全的  我是在百度文库没封杀之前下载在硬盘上的 现在应该还有文档。知道源地址的同仁 吱我一声。

有更好的也吱一声。 呵呵 ☺有想法的同仁也 评论几句。

 

 

最后预祝大家 2010事事顺心,吉祥万福！：)