Click here to Skip to main content
Click here to Skip to main content

Using C calling convention callback functions in C# and VB - the easy way

, 13 Sep 2005
Rate this:
Please Sign up or sign in to vote.
Provides an easy way to use C calling convention callback functions in C# and VB.

The problem

Let's assume that the following is presented:

  1. Function in an unmanaged DLL that accepts function pointer as parameter.
  2. The type of the function pointer respects the C calling convention (is declared with __cdecl).
  3. You need to import that function in your C# or VB program and to pass a delegate to it.
  4. Your delegate would be called more than once.

Here is an example:

DLL library header file

typedef void (__cdecl *func_type)(int count);

TESTLIB_API void __cdecl SetCallback( func_type func );

C# code

[DllImport("TestLib.dll",CallingConvention=CallingConvention.Cdecl)]
public static extern void SetCallback( MulticastDelegate callback );

What you would do is define a delegate type:

public delegate void CallbackDelegate( int count );

and pass an instance of it to the unmanaged function.

[STAThread]
static void Main(string[] args)
{
    CallbackDelegate del = new CallbackDelegate( Callback );
    SetCallback( del );
}

private static void Callback( int count )
{
    Console.WriteLine( "Callback invoked for " + 
                                          count + " time" );
}

Then your delegate should be invoked one or more times.

The problem is that the function pointer that the unmanaged function accepts should respect the C calling convention but the delegate instance you pass to it does not (it respects the standard calling convention (__stdcall). As a result, after the first call of the method from unmanaged code, the stack becomes corrupted and on the second or third call, a System.NullReferenceException is thrown.

Description of the same problem can be found here. Note that the problem exists only for callback functions that accept parameters.

Solution

The solution can be found here and here. The solution is (as the above posts suggest) apply modification option on the "Invoke" method of the delegate's type:

.method public hidebysig virtual instance native int
    modopt([mscorlib]System.Runtime.CompilerServices.CallConvCdecl)
    Invoke(int32 cb) runtime managed
{
} // end of method ...::Invoke

The original method generated by the C# and VB compilers look like this:

.method public hidebysig virtual instance native int
    Invoke(int32 cb) runtime managed
{
} // end of method ...::Invoke

(without modification option)

This cannot be done directly in your code as there is no way to specify modification options (or at least modification options that concern calling conventions) in C# and VB.

The drawback of the solution is that you need to disassemble your assembly, add the modification option and compile it. This is not a big deal, but what if you can apply the solution at run-time without the need to disassemble and recompile the code!

Run-time delegate type generation

The solution presented in this article does exactly the same but at run-time by generating the delegate types: it allows you to generate and use delegate types for any method.

More specifically it:

  • is able to generate delegate types for any method and specified System.Runtime.InteropServices.CallingConvention,
  • the generated types look exactly as the types generated by the C# and VB compilers but with modification option applied on the "Invoke" method,
  • is able to create instances of the generated types.
  • caches the generated types per method and CallingConvention.

However, something is not implemented: a delegate generated by C# or VB compiler can have marshaling information on parameters.

If you apply [MarshalAs] attribute on the parameters of a delegate declaration marshaling would be specified for those parameters in the delegate type generated by C# or VB compiler. This solution does not provide a way to specify marshaling of parameters, although it can be implemented. Any other parameter attributes like [In], [Out], ref, default value, etc. are handled (see System.Reflection.ParameterAttributes).

Using the solution

To obtain a delegate instance simply invoke one of the App.Runtime.InteropServices.DelegateGenerator methods. This method will generate a delegate type (if not already generated for the particular method and calling convention) and return an instance of it.

To make the delegate generation transparent to your code you can use the code like this:

/// <summary>
/// Callback delegate.
/// </summary>
public delegate void CallbackDelegate( int count );

/// <summary>
/// Sets specified callback method.
/// </summary>
/// <param name="callback"></param>
public static void SetCallback( CallbackDelegate callback )
{
    SetCallback( DelegateGenerator.CreateDelegate( callback ) );
}

/// <summary>
/// Sets specified callback method.
/// </summary>
/// <param name="callback"></param>
[DllImport("TestLib.dll",
           CallingConvention=CallingConvention.Cdecl)]
private static extern void SetCallback( 
                          MulticastDelegate callback );

You expose a delegate type and a "proxy" method that accepts an instance of that delegate type and passes adjusted version of it to the imported method.

Implementation

Delegate types are generated by using the types declared in the System.Reflection.Emit namespace. Unfortunately, they do not provide ways to specify modification options so modification options are added by a little "hack" on the generated methods' signatures. That involves the usage of reflection.

Source code and demo

The source code includes the App.Runtime.InteropServices.DelegateGenerator type and a reflection helper type.

There are two demo projects implemented in C# and VB that demonstrate the usage of generated delegate and normal delegate. Usage of normal delegate leads to stack corruption and System.NullReferenceException.

The demo includes C++ unmanaged library.

License

This article has no explicit license attached to it but may contain usage terms in the article text or the download files themselves. If in doubt please contact the author via the discussion board below.

A list of licenses authors might use can be found here

Share

About the Author

Jecho Jekov
Software Developer (Senior)
Bulgaria Bulgaria
No Biography provided

Comments and Discussions

 
GeneralRe: Error message when running application compiled under VS2008 Pinmemberjasonshen20623-Mar-10 20:05 
GeneralRe: Error message when running application compiled under VS2008 PinmemberJecho Jekov24-Mar-10 0:32 
GeneralEVERYONE USE THIS CODE WITH .NET 1.1 ONLY PinmemberJecho Jekov15-Dec-08 3:22 
GeneralGreat Artical PinmemberKhayralla13-Dec-08 12:47 
GeneralRe: Great Artical PinmemberJecho Jekov15-Dec-08 3:14 
QuestionMultiple Callbacks? PinmemberPHOLAN4-Nov-08 10:08 
AnswerRe: Multiple Callbacks? PinmemberJecho Jekov15-Dec-08 3:17 
GeneralStill same issue in VS 2008 .... BUT DUDE.. U DON'T NEED THIS custom delegate at all..... Pinmemberjsfunfun10-Mar-08 15:54 
unless i misunderstood ur example... (and btw, great idea and coding).. but you already have the answer before coding this...
 
if the delegate expects to be called as a standard __stdcall.. then all u have to do it preface ur callback pointer in the DLL with...
 
(__stdcall)...
 
so for example.. all my exported func's in the DLL have:
extern "C" __declspec( dllexport ) int myFunc(...);
 
it works like a charm. u can have different calling conventions in the same DLL....
 
here are the required code parts...
 
//////////////////////////////////////// win32 DLL code....
// .h file
#define MXOBJECT_API extern "C" __declspec( dllexport )
typedef void (__stdcall *w_CallBack) (int status);
 
// .cpp file
w_CallBack dnQueryCallBack; // my .Net callback delegate
 
MXOBJECT_API bool SetQueryHandler(w_CallBack dnDelegatePtr) {
// dnQueryCallBack now points to the .net delegate in Managed Code
dnQueryCallBack = dnDelegatePtr;
return true;
}
 
// test func to have .Net call and tell it to fire the .Net delegate
MXOBJECT_API int CallQueryHandler(int data) {
dnQueryCallBack(data);
return -data; // just to check something
}
 

 
//////////////////////////////////////// .Net bridge to DLL code...
 
class MxObjectAPI
{
[DllImport("MxObject.dll", CallingConvention = CallingConvention.Cdecl)]
public static extern bool SetQueryHandler(MulticastDelegate d);
 
[DllImport("MxObject.dll", CallingConvention = CallingConvention.Cdecl)]
public static extern int CallQueryHandler(int data);
}
 
public delegate int QueryDelegate(int cmdID);
public class QueryCallBack
{
public int OnQuery(int cmdID)
{
return cmdID;
}
}
 
public class MxBridge
{
QueryCallBack cb = null;
MulticastDelegate qd = null;
 
public MxBridge()
{
cb = new QueryCallBack();
qd = new QueryDelegate(cb.OnQuery);
 
// call the dll and set the function callback pointer
bool rVal = MxObjectAPI.SetQueryHandler(qd);
if (rVal == false)
{
throw new Exception("MxBridge: could not set function callback.");
}
}
 
public int CallQueryHandler(int cmdID)
{
return MxObjectAPI.CallQueryHandler(cmdID);
}
}
 

//////////////////////////////////////// .Net main.cs code...... an example call to dll to make it call .net
 
MxBridge mx = new MxBridge();
for (int i = 0; i < 1000; ++i)
{
int rval = mx.CallQueryHandler(i * 5);
}
 
(ps.. but i learned somethings from ur Reflection example - thx Smile | :) )
QuestionRe: Still same issue in VS 2008 .... BUT DUDE.. U DON'T NEED THIS custom delegate at all..... PinmemberMichaelFranz26-Jul-08 17:18 
GeneralRe: Still same issue in VS 2008 .... BUT DUDE.. U DON'T NEED THIS custom delegate at all..... PinmemberDLChambers19-Jul-11 8:56 
QuestionCan this code with in VS2005? Pinmemberplevintampabay1-Nov-07 16:29 
AnswerRe: Can this code with in VS2005? PinmemberJecho Jekov11-Nov-07 22:12 
NewsANYONE USING THE POSTED CODE PLEASE READ THIS COMMENT PinmemberJecho Jekov15-Oct-07 10:22 
QuestionHow about using the callback function in the form class? PinmemberTed Lin5-Oct-07 2:35 
AnswerRe: How about using the callback function in the form class? PinmemberJecho Jekov15-Oct-07 10:10 
GeneralRe: How about using the callback function in the form class? PinmemberTed Lin15-Oct-07 17:07 
GeneralThanks, works like a charm! PinmemberTyped_stratoCASTer13-Sep-07 19:27 
GeneralRe: Thanks, works like a charm! PinmemberJecho Jekov14-Sep-07 4:18 
GeneralRuntime exceptions in VS2005 PinmemberAlgerChan12-Aug-06 18:48 
GeneralRe: Runtime exceptions in VS2005 PinmemberHusam Burhan14-Aug-06 9:45 
GeneralRe: Runtime exceptions in VS2005 Pinmembera010405019-Dec-09 6:19 
GeneralRe: Runtime exceptions in VS2005 PinmemberHusam Burhan19-Dec-09 23:36 
AnswerRe: Runtime exceptions in VS2005 PinmemberJecho Jekov22-Dec-09 4:28 
GeneralRe: Runtime exceptions in VS2005 Pinmemberbprajap25-Sep-06 8:50 
GeneralRe: Runtime exceptions in VS2005 Pinmemberroylory7-Nov-06 15:17 

General General    News News    Suggestion Suggestion    Question Question    Bug Bug    Answer Answer    Joke Joke    Rant Rant    Admin Admin   

Use Ctrl+Left/Right to switch messages, Ctrl+Up/Down to switch threads, Ctrl+Shift+Left/Right to switch pages.

| Advertise | Privacy | Terms of Use | Mobile
Web03 | 2.8.1411022.1 | Last Updated 13 Sep 2005
Article Copyright 2005 by Jecho Jekov
Everything else Copyright © CodeProject, 1999-2014
Layout: fixed | fluid