How Do I...Call a Function Exported From an Unmanaged Library?

This example demonstrates how to call a function exported from an unmanaged library from managed code. The MessageBox routine in User32.dll and GetSystemTime routine in Kernel32.dll are called. The same technique can be used to call any exported function in any other library.

In order to call MessageBox and GetSystemTime, you need the metadata that describes each method and its arguments. The necessary metadata is provided by defining a managed class with one or more static methods. The class and the static methods can have any name you choose. You might want to create several classes that contain related functions or simply group all the functions you need into a single class.

In C# the DllImport attribute is used to identify the name of the actual DLL that contains the exported function. The method must be defined as static and external in order to apply the attribute. In VB.NET the Declare statement serves the same purpose.

Many unmanaged DLL functions expect you to pass structures, as a parameter to the function. When using platform invoke to pass a structure, you must provide additional information to format the type. In managed code, a formatted type is a structure or class that is annotated with the StructLayoutAttribute to ensure predictable layout information to its members.

Once the class and methods are defined, the method can be called like any other method.

using System.Runtime.InteropServices; [StructLayout(LayoutKind.Sequential)] public struct SystemTime { public ushort wYear; ... } public class Win32 { [DllImport("Kernel32.dll")] public static extern void GetSystemTime(ref SystemTime sysTime); ... } public class TestPInvoke { public static void Main() { SystemTime sysTime = new SystemTime(); Win32.GetSystemTime(ref sysTime); ... } } imports System.Runtime.InteropServices Public Structure _ <StructLayout(LayoutKind.Sequential)> SystemTime Public wYear As Short ... End Structure Public Class Win32 Declare Auto Sub GetSystemTime _ Lib "Kernel32.dll"(ByRef sysTime As SystemTime) ... End Class Public Class TestPInvoke Public Shared Sub Main() Dim sysTime As New SystemTime() Win32.GetSystemTime(sysTime) ... End Sub End Class using namespace System::Runtime::InteropServices; [StructLayout(LayoutKind::Sequential)] public __gc struct SystemTime { unsigned short wYear; unsigned short wMonth; ... } public __gc class Win32 { public: [DllImport("Kernel32.dll")] static void GetSystemTime(SystemTime * sysTime); ... } void main() { SystemTime * sysTime = new SystemTime(); Win32 * w = new Win32; w -> GetSystemTime(sysTime); ... }

If the name of the method is different than the actual export name in the DLL, the DllImport.EntryPoint property can be used to map the function to the correct entry point if you are using C#. In Visual Basic you can use Alias keyword for this purpose.

using System.Runtime.InteropServices; public class Win32 { ... [DllImport("User32.dll", EntryPoint="MessageBox", CharSet=CharSet.Auto)] public static extern int MsgBox(int hWnd, String text, String caption, uint type); } public class TestPInvoke { public static void Main() { ... String date = ...; Win32.MsgBox(0, date, "PInvoke Sample", 0); } } using System.Runtime.InteropServices; Public Class Win32 ... Declare Auto Function MsgBox Lib "User32.dll" Alias "MessageBox" _ (hWnd As Integer, txt As String, caption As String, Typ As Integer) As Integer End Class Public Class TestPInvoke Public Shared Sub Main() ... Dim dt As String dt = ... Win32.MsgBox(0, dt, "Platform Invoke Sample", 0) End Sub End Class using System.Runtime.InteropServices; public __gc class Win32 { ... [DllImport("User32.dll", EntryPoint="MessageBox", CharSet=CharSet::Auto)] static int MsgBox(int hWnd, String * text, String * caption, unsigned int type); }; void Main() { ... String *date = ...; w -> MsgBox(0, date, S"PInvoke Sample", 0); }

Also, you can specify the entry by ordinal rather than by name.

[DllImport("User32.dll", EntryPoint="#452")] public static extern int MsgBox(int hWnd, String text, String caption, uint type); Declare Function MsgBox Lib "User32.dll" Alias "#452" _ (hWnd As Integer, txt As String, caption As String, Typ As Integer) As Integer [DllImport("User32.dll", EntryPoint="MessageBox", CharSet=CharSet::Auto)] static int MsgBox(int hWnd, String * text, String * caption, unsigned int type);