DllImportAttribute.CallingConvention Field

Reference

Definition

Namespace:: System.Runtime.InteropServices

Assemblies:: mscorlib.dll, System.Runtime.InteropServices.dll

Assemblies:: netstandard.dll, System.Runtime.InteropServices.dll

Assembly:: System.Runtime.InteropServices.dll

Assembly:: mscorlib.dll

Assembly:: netstandard.dll

Source:: DllImportAttribute.cs

Source:: DllImportAttribute.cs

Source:: DllImportAttribute.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Indicates the calling convention of an entry point.

public: System::Runtime::InteropServices::CallingConvention CallingConvention;

public System.Runtime.InteropServices.CallingConvention CallingConvention;

val mutable CallingConvention : System.Runtime.InteropServices.CallingConvention

Public CallingConvention As CallingConvention

Field Value

CallingConvention

Examples

In some cases, Visual Basic developers use the DllImportAttribute, instead of the Declare statement, to define a DLL function in managed code. Setting the CallingConvention field is one of those cases.

using namespace System;
using namespace System::Runtime::InteropServices;

private ref class NativeMethods
{
    // Managed class methods don't support varargs so all arguments must be
    // explicitly defined. CallingConvention.Cdecl must be used since the
    // stack is cleaned up by the caller.
    // int printf(const char *format [, argument]...)
public:
    [DllImport("msvcrt.dll", CharSet = CharSet::Ansi,
        CallingConvention = CallingConvention::Cdecl)]
    static int printf(String^ format, int i, double d);

    [DllImport("msvcrt.dll", CharSet = CharSet::Ansi,
        CallingConvention = CallingConvention::Cdecl)]
    static int printf(String^ format, int i, String^ s);
};

void main()
{
    NativeMethods::printf("\nPrint params: %i %f", 99, 99.99);
    NativeMethods::printf("\nPrint params: %i %s", 99, "abcd");
}

using System;
using System.Runtime.InteropServices;

internal static class NativeMethods
{
    // C# doesn't support varargs so all arguments must be explicitly defined.
    // CallingConvention.Cdecl must be used since the stack is
    // cleaned up by the caller.
    // int printf(const char *format [, argument]...)
    [DllImport("msvcrt.dll", CharSet = CharSet.Ansi,
        CallingConvention = CallingConvention.Cdecl)]
    internal static extern int printf(string format, int i, double d);

    [DllImport("msvcrt.dll", CharSet = CharSet.Ansi,
        CallingConvention = CallingConvention.Cdecl)]
    internal static extern int printf(string format, int i, string s);
}

public class App
{
    public static void Main()
    {
        NativeMethods.printf("\nPrint params: %i %f", 99, 99.99);
        NativeMethods.printf("\nPrint params: %i %s", 99, "abcd");
    }
}

Imports System.Runtime.InteropServices

Friend Class NativeMethods
    ' Visual Basic doesn't support varargs so all arguments must be explicitly defined.
    ' CallingConvention.Cdecl must be used since the stack is
    ' cleaned up by the caller.
    ' int printf(const char *format [, argument]...)
    <DllImport("msvcrt.dll", CharSet:=CharSet.Ansi,
        CallingConvention:=CallingConvention.Cdecl)>
    Friend Shared Function printf(format As String, i As Integer, d As Double) As Integer
    End Function
    <DllImport("msvcrt.dll", CharSet:=CharSet.Ansi,
        CallingConvention:=CallingConvention.Cdecl)>
    Friend Shared Function printf(format As String, i As Integer, s As String) As Integer
    End Function
End Class

Public Class App
    Public Shared Sub Main()
        NativeMethods.printf(vbCrLf + "Print params: %i %f", 99, 99.99)
        NativeMethods.printf(vbCrLf + "Print params: %i %s", 99, "abcd")
    End Sub
End Class

Remarks

You set this field to one of the CallingConvention enumeration members. The default value for the CallingConvention field is Winapi, which in turn defaults to StdCall convention on Windows, and Cdecl on all other platforms.

Applies to

Product	Versions
.NET	Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9, 10
.NET Framework	1.1, 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard	1.1, 1.2, 1.3, 1.4, 1.5, 1.6, 2.0, 2.1
UWP	10.0

Share via