简单介绍如何在C#项目中使用P/Invoke调用C/C+ +动态链接库中的函数,建议只用P/Invoke调用一些简单的C/C+ +函数,函数传参太过复杂时,采用C+ +/CLI的混合编程方式。
前面的文章《C+ +/CLI基本语法和最佳实践》提到,P/Invoke是.NET提供的一种轻量机制,允许托管代码调用C/C+ +编写的动态链接库,当C#项目需要调用少量原生代码时,这种方式非常方便。
C#和C+ +/CLI项目都可以使用P/Invoke机制,但本文只关注前者。
简单实例
封装C/C+ +函数库
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28
| #pragma once #include <iostream>
extern "C" { MYDLL_API void TestPInvoke1() { std::cout << "Hello PInvoke" << std::endl; }
MYDLL_API double Add(double a, double b) { return a + b; }
MYDLL_API double Sum(double data[], int num) { double sum = 0; for (size_t i = 0; i < num; i++) sum += data[i]; return sum; }
MYDLL_API void ShowText(const char* text) { std::cout << text << std::endl; } }
|
在C#中使用
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37
| using System; using System.Runtime.InteropServices;
namespace TestPInvoke { internal class Program { [DllImport("D:\\Projects\\LearnCSharp\\out\\CPPDLL.dll", CallingConvention = CallingConvention.Cdecl, EntryPoint = "TestPInvoke1", ExactSpelling = true)] private static extern void Test01();
[DllImport("user32.dll", CallingConvention = CallingConvention.Winapi, CharSet = CharSet.Unicode, SetLastError = true)] private static extern int MessageBox(IntPtr hWnd, string lpText, string lpCaption, uint uType);
[DllImport("D:\\Projects\\LearnCSharp\\out\\CPPDLL.dll")] private static extern double Add(double a, double b);
[DllImport("D:\\Projects\\LearnCSharp\\out\\CPPDLL.dll")] private static extern double Sum(double[] data, int num);
[DllImport("D:\\Projects\\LearnCSharp\\out\\CPPDLL.dll")] private static extern void ShowText(string text);
static void Main(string[] args) { Test01(); MessageBox(IntPtr.Zero, "正在测试PInvoke", "温馨提示", 1);
Console.WriteLine(Add(10.0, 12.0));
double[] data = { 1, 2, 3, 4, 5 }; Console.WriteLine(Sum(data, 5));
ShowText("I am PInvoke"); } } }
|
规则总结
参数类型转换
(1)基本的整数、浮点、布尔类型、字符串、基本数据类型的数组可以自动转换;P/Invoke的数据类型转换远不如C+ +/CLI的灵活,建议只用P/Invoke调用一些简单的C/C+ +函数。
(2)导出自定义函数时,使用extern "C"标识,PInvoke时使用CallingConvention.Cdecl导出规则。
(3)EntryPoint可以指定DLL中的函数名称;ExactSpelling默认为false,设置为true时,要求指定的函数名称与DLL中的名称完全一致,在某些情况下可能出错(指定extern "C"导出方式后DLL中的函数名称是一样的)。
(4)CallingConvention可以指定调用约定,默认为Winapi方式(同Stdcall方式),它们与Cdecl基本一致,但是对于Windows API的某些函数,会做微调,例如将MessageBox重编为MessageBoxA或MessageBoxW。如果将上例中的MessageBox调用改为如下代码,则会报错:
1 2 3 4 5 6
| [DllImport("user32.dll", CallingConvention = CallingConvention.Winapi, CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling=true)] private static extern int MessageBox(IntPtr hWnd, string lpText, string lpCaption, uint uType);
|
原因是:设置ExactSpelling=true后,必须与DLL中的函数名称完全匹配才行,但是user32.dll中并没有MessageBox这个函数,将MessageBox改为MessageBoxW即可。