Visual C++ 使用 __declspec(dllexport) 从 DLL 导出 (到C#)
由于各种的原因， 如何把unmanaged 的 c++ DLL 转换成 managed C# 是一个问题。
方法有3个.
Ø 使用.def文件
Ø 可以不用.def文件, 使用__declspec(dllexport)关键字, 特别是针对Visual C++编译器的时候
Ø 直接用MC++写
什么时候用.def文件?
.def的意思是module-definition， 这个纯文本的文件定义了模块的信息。 对于编译器来说， 一个方法在编译之后的DLL文件里， 存在的形式名字可能不是作者当时起的那个，例如好好的函数名字function() 变成了?function2@@YAXXZ; 可以用undname查看这个被编译器修饰掉的名字, 原型是"void __cdecl function2(void)". 大概使用的时候就会遇到类似”链接错误，未决的外部符号…” 的错误.
.def文件主要的作用, 就是”标注” 出这个函数原来的样子, 这样编译器在编译的时候, 规则上就会以C编译器的规则来处理, 修饰被去掉了, 另外同时可以把导出函数的序号值手动的改高一点; 还有一个优点(也是缺点) 就是可以用NONAME来修饰函数, 这样导出函数的序号值就变成了1~N, 即第N个函数. 所以调用GetProcAddress() 的时候, 可以直接用定义的序号值, 而不用写函数的名字(但是名字就完全不可用了), 更好的是, 导出函数的这个DLL会变得比较小, 当然, MSDN强调了一点: 仅你可以并有权更改这个.def文件内容的时候, 你才可以用这个办法.
那么， 什么时候考虑用.def文件呢? 因为编译器不同, 而产生的修饰名不同的话, 这个文件就是必须的.
注意如果文件没有导出函数的话， 这个文件可能降低运行效率。
.def文件的格式
LIBRARY FileNameWithoutExtension
EXPORTS
Function1 @1
Function3 @2
Function2 @3 NONAME
启用 Enable it: Property pages-> Configuration Properties->C/C++ -> Linker -> input -> Module Definition File
那不用.def呢? __declspec(dllexport)的作用
这个东西, 可以给函数用, 也可以给类用. 声明大概这样子:
__declspec(dllexport) int __stdcall GetMid(vector<type> ve);
class __declspec(dllexport) TestClass{
public :
TestClass();
}
这牵扯到了一个东西就是__stdcall和__cdecl (还有__fastcall, 不过很少用), 其中__cdecl一般是C或者C++的缺省调用规范, 但是最大的一个区别就是__stdcall在返回前自身清除堆栈, 而__cdecl是调用方来做这个事情(可参考COM中的某些机制), 另一个区别就是__stdcall对于可变参数的函数, 玩不转.
反正今时今日, 大家都在用__stdcall, 所以这么写也没什么问题, 但不是没有. VB里调用标记着__cdecl的方法, 可能会得到一个异常Bad DLL Calling Convention. 解决方法也很简单:
原来的函数
long _cdecl PassStr(LPSTR pStr)
{ return 1; }
新的函数
long _stdcall PassStrStdCall(LPSTR pStr)
{ return PassStr(pStr); }
问题是, 如果这个函数原型, 参数是可变的, 那又怎么弄呢?
调用的时候， C#都是这么写的：
[DllImport("", EntryPoint = @" ?GetMid@@YAXXZ", CharSet = CharSet.Auto)]
private static extern void GetMid(...);
这个入口点名字还真别扭， 看来去掉这个修饰还是蛮需要的， 除了用.def文件, 另一个办法就是用 extern “C”.
Extern “C”
一句话总结：这个东西可以去掉修饰名。在不用.def文件的前提下, 这个可以保证你的函数function() 还是这个名字.
但是，这个东西对类不太起作用！
这个东西是这么用的： 放到函数声明的最前面。 就类似这样 extern “C” void __declspec(dllexport) function(void);
对于类， 一般的做法是， 把它的内部方法（特别是实例方法，或变量），wrap出一个方法来。 见下面的实例.
还要做什么？
当一个DLL被初始化的时候， 它需要一个入口点， 一般对于非MFC DLL来说， 这样写就行了：
BOOL APIENTRY DllMain(HANDLE hModule,
DWORD ul_reason_for_call,
LPVOID lpReserved
)
{
switch( ul_reason_for_call )
{
case DLL_PROCESS_ATTACH:
case DLL_THREAD_ATTACH:
case DLL_THREAD_DETACH:
case DLL_PROCESS_DETACH:
break;
}
return TRUE;
}
要注意的是这个入口点的名字必须是DllMain， 如果不是需要修改linker的/entry 选项. 否则对于C的话可能会初始化失败.
************************************************************************
开始用导出函数 PInvoke
为了好看一点， 先约定一下：
#define EXT_C extern "C" #define DLLEXPORT __declspec(dllexport) #define EXT_C_DLLEXPORT EXT_C DLLEXPORT #define CALLBACK __stdcall #define WINAPI __stdcall #define APIENTRY WINAPI
1. 普通的函数
EXT_C_DLLEXPORT void WINAPI Function();
[DllImport("filename.dll", EntryPoint = " Function")]
private static extern void Func();
2. ref或者out
EXT_C_DLLEXPORT void WINAPI Function(Type** ty);
[DllImport("filename.dll", EntryPoint = " Function")]
private static extern void Func(out Type ty);
3. 指针函数和委托
Typedef void (CALLBACK *pFunc)(int);
EXT_C_DLLEXPORT void WINAPI Compare(int a, int b, pFunc p);
private delegate int CompareCallback(int a, int b);
[DllImport("filename.dll",EntryPoint=”Compare”)]
private static extern int Compare(int a, int b, CompareCallback call);
4. 类的处理. 其实不是说不可以把类标记为 DLLEXPORT, 如果可以的话, 当然是wrap比较好
C++里的原型
class DLLEXPORT Test
{
public :
Test();
~Test();
BOOL function(int par)
};
类被export， 函数调用时候注意用CallingConvention.ThisCall.
[DllImport("filename.dll", EntryPoint = @"??4Test@@QEAAAEAV0@AEBV0@@Z", CallingConvention = CallingConvention.ThisCall)]
private static extern int TestFunc(IntPtr hwnd, int par);
采用了”迂回”策略, C++里先这样定义,同理, 添加构造函数等, 函数就变成了这个样子:
EXT_C_DLLEXPORT BOOL WINAPI function_wrap(Test* t, int par)
{
return t->function(par);
}
EXT_C_DLLEXPORT Test* Test_ctor()
{
Test* t = new Test();
return t;
}
EXT_C_DLLEXPORT void Test_dector(Test* t)
{
if(NULL == t)
{
delete t;
t = NULL;
}
}
在C#里这样写, 那么就和平时用没什么区别了.
public class Test : IDisposable
{
private IntPtr instance;
public Test()
{
instance = CreateInstance();
}
~Test()
{
Dispose(false);
}
#region pinvoke
[DllImport("filename.dll", EntryPoint = @"Test_ctor")]
private static extern IntPtr CreateInstance();
[DllImport("filename.dll", EntryPoint = @"Test_dector")]
private static extern void DestroyInstance(IntPtr hwnd);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("filename.dll", EntryPoint = @"function_wrap")]
private static extern bool function_wrap(int par);
#endregion
#region IDisposable Members
public void Dispose()
{
Dispose(true);
}
private void Dispose(bool bDisposing)
{
if (instance != IntPtr.Zero)
{
DestroyInstance(instance);
}
if (bDisposing)
{
GC.SuppressFinalize(this);
}
}
#endregion
}
5. Struct操作.
typedef struct Object_HANDLE {
unsigned long dbch_size;
HANDLE dbch_handle;
GUID dbch_eventguid;
BOOL res_flag;
} Object_Native_HANDLE ;
首先在C#里严格定义这个，LayoutKind.Sequential 用来保证内存分配的正常。
[StructLayout(LayoutKind.Sequential)]
public struct Object_Native_HANDLE
{
public ulong dbch_size;
public IntPtr dbch_handle;
public Guid dbch_eventGuid;
public bool res_flag;
}
Marshal的使用如下：
Object_Native_HANDLE obj = new Object_Native_HANDLE(); //初始化
int amountToAllocate = Marshal.SizeOf(obj);//获取大小
IntPtr objPtr = Marshal.AllocHGlobal(amountToAllocate); //分配并获取空的空间地址
Marshal.StructureToPtr(obj, objPtr, false); // 值写入分配的空间
//操作...
Marshal.FreeHGlobal(objPtr);//释放空间
最后提一句， unmaged code中的错误， 到managed 以后， 极大可能是捕捉不到的。 所以错误需要分别处理。
花了不少时间， MC++平时用的不多， 不写了。
参考
http://www.codeproject.com/KB/cs/marshalCPPclass.aspx
http://www2.research.att.com/~bs/bs_faq2.html
http://home.hiwaay.net/~georgech/WhitePapers/Exporting/Exp.htm
http://msdn.microsoft.com/zh-cn/library/9h658af8(VS.80).aspx
