TypeBuilder.DefinePInvokeMethod Método

Definição

Namespace:

System.Reflection.Emit

Assemblies:

netstandard.dll, System.Reflection.Emit.dll

Define um método PInvoke.

Sobrecargas

DefinePInvokeMethod(String, String, MethodAttributes, CallingConventions, Type, Type[], CallingConvention, CharSet)	Define um método PInvoke após serem informados seu nome, o nome da DLL em que o método é definido, os atributos do método, a convenção de chamada do método, o tipo de retorno do método, os tipos dos parâmetros do método e os sinalizadores PInvoke.
DefinePInvokeMethod(String, String, String, MethodAttributes, CallingConventions, Type, Type[], CallingConvention, CharSet)	Define um método PInvoke após serem informados seu nome, o nome da DLL no qual o método é definido, o nome do ponto de entrada, os atributos do método, a convenção de chamada do método, o tipo de retorno do método, os tipos dos parâmetros do método, os sinalizadores PInvoke.
DefinePInvokeMethod(String, String, String, MethodAttributes, CallingConventions, Type, Type[], Type[], Type[], Type[][], Type[][], CallingConvention, CharSet)	Define um método PInvoke após serem informados seu nome, o nome da DLL no qual o método é definido, o nome do ponto de entrada, os atributos do método, a convenção de chamada do método, o tipo de retorno do método, os tipos dos parâmetros do método, os sinalizadores PInvoke e os modificadores personalizados para os parâmetros e o tipo de retorno.

DefinePInvokeMethod(String, String, MethodAttributes, CallingConventions, Type, Type[], CallingConvention, CharSet)

Origem:

TypeBuilder.cs

Define um método PInvoke após serem informados seu nome, o nome da DLL em que o método é definido, os atributos do método, a convenção de chamada do método, o tipo de retorno do método, os tipos dos parâmetros do método e os sinalizadores PInvoke.

C#

public System.Reflection.Emit.MethodBuilder DefinePInvokeMethod(string name, string dllName, System.Reflection.MethodAttributes attributes, System.Reflection.CallingConventions callingConvention, Type? returnType, Type[]? parameterTypes, System.Runtime.InteropServices.CallingConvention nativeCallConv, System.Runtime.InteropServices.CharSet nativeCharSet);

Parâmetros

name

String

O nome do método PInvoke. name não pode conter nulos inseridos.

dllName

String

O nome da DLL na qual o método PInvoke é definido.

attributes

MethodAttributes

Os atributos do método.

callingConvention

CallingConventions

A convenção de chamada do método.

returnType

Type

O tipo de retorno do método.

parameterTypes

Type[]

Os tipos de parâmetros do método.

nativeCallConv

CallingConvention

A convenção de chamada nativa.

nativeCharSet

CharSet

O conjunto de caracteres nativos do método.

Retornos

MethodBuilder

O método PInvoke definido.

Exceções

ArgumentException

O método não é estático.

- ou -

O tipo pai é uma interface.

- ou -

O método é abstrato.

- ou -

O método foi definido anteriormente.

- ou -

O comprimento de name ou dllName é zero.

ArgumentNullException

name ou dllName é null.

InvalidOperationException

O tipo recipiente foi criado anteriormente usando CreateType().

Exemplos

O exemplo a seguir demonstra como usar o DefinePInvokeMethod método para criar um PInvoke método e como adicionar o MethodImplAttributes.PreserveSig sinalizador aos sinalizadores de implementação do método depois de criar o MethodBuilder, usando os MethodBuilder.GetMethodImplementationFlags métodos e MethodBuilder.SetImplementationFlags .

Importante

Para obter um valor retornado diferente de zero, você deve adicionar o MethodImplAttributes.PreserveSig sinalizador .

O exemplo cria um assembly dinâmico com um módulo dinâmico e um único tipo, MyType, que contém o PInvoke método . O PInvoke método representa a função Win32 GetTickCount .

Quando o exemplo é executado, ele executa o PInvoke método . Ele também salva o assembly dinâmico como PInvokeTest.dll. Você pode usar o Ildasm.exe (IL Disassembler) para examinar a MyType classe e o static método (Shared no Visual Basic) PInvoke que ela contém. Você pode compilar um programa do Visual Basic ou C# que usa o método estático MyType.GetTickCount incluindo uma referência à DLL ao executar csc.exe ou vbc.exe; por exemplo, /r:PInvokeTest.dll.

C#

using System;
using System.Text;
using System.Reflection;
using System.Reflection.Emit;
using System.Runtime.InteropServices;

public class Example
{
    public static void Main()
    {
        // Create the AssemblyBuilder.
        AssemblyName asmName = new AssemblyName("PInvokeTest");
        AssemblyBuilder dynamicAsm = AppDomain.CurrentDomain.DefineDynamicAssembly(
            asmName,
            AssemblyBuilderAccess.RunAndSave
        );

        // Create the module.
        ModuleBuilder dynamicMod =
            dynamicAsm.DefineDynamicModule(asmName.Name, asmName.Name + ".dll");

        // Create the TypeBuilder for the class that will contain the
        // signature for the PInvoke call.
        TypeBuilder tb = dynamicMod.DefineType(
            "MyType",
            TypeAttributes.Public | TypeAttributes.UnicodeClass
        );

        MethodBuilder mb = tb.DefinePInvokeMethod(
            "GetTickCount",
            "Kernel32.dll",
            MethodAttributes.Public | MethodAttributes.Static | MethodAttributes.PinvokeImpl,
            CallingConventions.Standard,
            typeof(int),
            Type.EmptyTypes,
            CallingConvention.Winapi,
            CharSet.Ansi);

        // Add PreserveSig to the method implementation flags. NOTE: If this line
        // is commented out, the return value will be zero when the method is
        // invoked.
        mb.SetImplementationFlags(
            mb.GetMethodImplementationFlags() | MethodImplAttributes.PreserveSig);

        // The PInvoke method does not have a method body.

        // Create the class and test the method.
        Type t = tb.CreateType();

        MethodInfo mi = t.GetMethod("GetTickCount");
        Console.WriteLine("Testing PInvoke method...");
        Console.WriteLine("GetTickCount returned: {0}", mi.Invoke(null, null));

        // Produce the .dll file.
        Console.WriteLine("Saving: " + asmName.Name + ".dll");
        dynamicAsm.Save(asmName.Name + ".dll");
    }
}

/* This example produces output similar to the following:

Testing PInvoke method...
GetTickCount returned: 1312576235
Saving: PInvokeTest.dll
 */

Comentários

Alguns atributos de importação de DLL (consulte a descrição de DllImportAttribute) não podem ser especificados como argumentos para esse método. Por exemplo, o atributo MethodImplAttributes.PreserveSig de importação de DLL deve ser adicionado depois que o PInvoke método é criado, se o método retorna um valor. O exemplo mostra como fazer isso.

DefinePInvokeMethod(String, String, String, MethodAttributes, CallingConventions, Type, Type[], CallingConvention, CharSet)

Origem:

TypeBuilder.cs

Define um método PInvoke após serem informados seu nome, o nome da DLL no qual o método é definido, o nome do ponto de entrada, os atributos do método, a convenção de chamada do método, o tipo de retorno do método, os tipos dos parâmetros do método, os sinalizadores PInvoke.

C#

public System.Reflection.Emit.MethodBuilder DefinePInvokeMethod(string name, string dllName, string entryName, System.Reflection.MethodAttributes attributes, System.Reflection.CallingConventions callingConvention, Type? returnType, Type[]? parameterTypes, System.Runtime.InteropServices.CallingConvention nativeCallConv, System.Runtime.InteropServices.CharSet nativeCharSet);

Parâmetros

name

String

O nome do método PInvoke. name não pode conter nulos inseridos.

dllName

String

O nome da DLL na qual o método PInvoke é definido.

entryName

String

O nome do ponto de entrada na DLL.

attributes

MethodAttributes

Os atributos do método.

callingConvention

CallingConventions

A convenção de chamada do método.

returnType

Type

O tipo de retorno do método.

parameterTypes

Type[]

Os tipos de parâmetros do método.

nativeCallConv

CallingConvention

A convenção de chamada nativa.

nativeCharSet

CharSet

O conjunto de caracteres nativos do método.

Retornos

MethodBuilder

O método PInvoke definido.

Exceções

ArgumentException

O método não é estático.

- ou -

O tipo pai é uma interface.

- ou -

O método é abstrato.

- ou -

O método foi definido anteriormente.

- ou -

O comprimento de name, dllName ou entryName é zero.

ArgumentNullException

name, dllName ou entryName é null.

InvalidOperationException

O tipo recipiente foi criado anteriormente usando CreateType().

Exemplos

O exemplo de código a seguir demonstra como usar o DefinePInvokeMethod método para criar um PInvoke método e como adicionar o MethodImplAttributes.PreserveSig sinalizador aos sinalizadores de implementação do método depois de criar o MethodBuilder, usando os MethodBuilder.GetMethodImplementationFlags métodos e MethodBuilder.SetImplementationFlags .

Importante

Para obter um valor retornado diferente de zero, você deve adicionar o MethodImplAttributes.PreserveSig sinalizador .

O exemplo cria um assembly dinâmico com um módulo dinâmico e um único tipo, MyType, que contém o PInvoke método . O PInvoke método representa a função Win32 GetTickCount .

Quando o exemplo é executado, ele executa o PInvoke método . Ele também salva o assembly dinâmico como PInvokeTest.dll. Você pode usar o Ildasm.exe (IL Disassembler) para examinar a MyType classe e o static método (Shared no Visual Basic) PInvoke que ela contém. Você pode compilar um programa do Visual Basic ou C# que usa o método estático MyType.GetTickCount incluindo uma referência à DLL ao executar csc.exe ou vbc.exe; por exemplo, /r:PInvokeTest.dll.

C#

using System;
using System.Text;
using System.Reflection;
using System.Reflection.Emit;
using System.Runtime.InteropServices;

public class Example
{
    public static void Main()
    {
        // Create the AssemblyBuilder.
        AssemblyName asmName = new AssemblyName("PInvokeTest");
        AssemblyBuilder dynamicAsm = AppDomain.CurrentDomain.DefineDynamicAssembly(
            asmName,
            AssemblyBuilderAccess.RunAndSave
        );

        // Create the module.
        ModuleBuilder dynamicMod =
            dynamicAsm.DefineDynamicModule(asmName.Name, asmName.Name + ".dll");

        // Create the TypeBuilder for the class that will contain the
        // signature for the PInvoke call.
        TypeBuilder tb = dynamicMod.DefineType(
            "MyType",
            TypeAttributes.Public | TypeAttributes.UnicodeClass
        );

        MethodBuilder mb = tb.DefinePInvokeMethod(
            "GetTickCount",
            "Kernel32.dll",
            MethodAttributes.Public | MethodAttributes.Static | MethodAttributes.PinvokeImpl,
            CallingConventions.Standard,
            typeof(int),
            Type.EmptyTypes,
            CallingConvention.Winapi,
            CharSet.Ansi);

        // Add PreserveSig to the method implementation flags. NOTE: If this line
        // is commented out, the return value will be zero when the method is
        // invoked.
        mb.SetImplementationFlags(
            mb.GetMethodImplementationFlags() | MethodImplAttributes.PreserveSig);

        // The PInvoke method does not have a method body.

        // Create the class and test the method.
        Type t = tb.CreateType();

        MethodInfo mi = t.GetMethod("GetTickCount");
        Console.WriteLine("Testing PInvoke method...");
        Console.WriteLine("GetTickCount returned: {0}", mi.Invoke(null, null));

        // Produce the .dll file.
        Console.WriteLine("Saving: " + asmName.Name + ".dll");
        dynamicAsm.Save(asmName.Name + ".dll");
    }
}

/* This example produces output similar to the following:

Testing PInvoke method...
GetTickCount returned: 1312576235
Saving: PInvokeTest.dll
 */

Comentários

Alguns atributos de importação de DLL (consulte a descrição de DllImportAttribute) não podem ser especificados como argumentos para esse método. Por exemplo, o atributo MethodImplAttributes.PreserveSig de importação de DLL deve ser adicionado depois que o PInvoke método é criado, se o método retorna um valor. O exemplo mostra como fazer isso.

DefinePInvokeMethod(String, String, String, MethodAttributes, CallingConventions, Type, Type[], Type[], Type[], Type[][], Type[][], CallingConvention, CharSet)

Origem:

TypeBuilder.cs

Define um método PInvoke após serem informados seu nome, o nome da DLL no qual o método é definido, o nome do ponto de entrada, os atributos do método, a convenção de chamada do método, o tipo de retorno do método, os tipos dos parâmetros do método, os sinalizadores PInvoke e os modificadores personalizados para os parâmetros e o tipo de retorno.

C#

public System.Reflection.Emit.MethodBuilder DefinePInvokeMethod(string name, string dllName, string entryName, System.Reflection.MethodAttributes attributes, System.Reflection.CallingConventions callingConvention, Type? returnType, Type[]? returnTypeRequiredCustomModifiers, Type[]? returnTypeOptionalCustomModifiers, Type[]? parameterTypes, Type[][]? parameterTypeRequiredCustomModifiers, Type[][]? parameterTypeOptionalCustomModifiers, System.Runtime.InteropServices.CallingConvention nativeCallConv, System.Runtime.InteropServices.CharSet nativeCharSet);

Parâmetros

name

String

O nome do método PInvoke. name não pode conter nulos inseridos.

dllName

String

O nome da DLL na qual o método PInvoke é definido.

entryName

String

O nome do ponto de entrada na DLL.

attributes

MethodAttributes

Os atributos do método.

callingConvention

CallingConventions

A convenção de chamada do método.

returnType

Type

O tipo de retorno do método.

returnTypeRequiredCustomModifiers

Type[]

Uma matriz de tipos que representam os modificadores personalizados obrigatórios, por exemplo IsConst, para o tipo de retorno do método. Se o tipo de retorno não tiver modificadores personalizados obrigatórios, especifique null.

returnTypeOptionalCustomModifiers

Type[]

Uma matriz de tipos que representam os modificadores personalizados opcionais, por exemplo IsConst, para o tipo de retorno do método. Se o tipo de retorno não tiver modificadores personalizados opcionais, especifique null.

parameterTypes

Type[]

Os tipos de parâmetros do método.

parameterTypeRequiredCustomModifiers

Type[][]

Uma matriz de matrizes de tipos. Cada matriz de tipos representa os modificadores personalizados obrigatórios para o parâmetro correspondente, por exemplo IsConst. Se um determinado parâmetro tiver não modificadores personalizados obrigatórios, especifique null em vez de uma matriz de tipos. Se nenhum dos parâmetros tiver modificadores personalizados obrigatórios, especifique null em vez de uma matriz de matrizes.

parameterTypeOptionalCustomModifiers

Type[][]

Uma matriz de matrizes de tipos. Cada matriz de tipos representa os modificadores personalizados opcionais para o parâmetro correspondente, por exemplo IsConst. Se um determinado parâmetro tiver não modificadores personalizados opcionais, especifique null em vez de uma matriz de tipos. Se nenhum dos parâmetros tiver modificadores personalizados opcionais, especifique null em vez de uma matriz de matrizes.

nativeCallConv

CallingConvention

A convenção de chamada nativa.

nativeCharSet

CharSet

O conjunto de caracteres nativos do método.

Retornos

MethodBuilder

Um MethodBuilder representando o método PInvoke definido.

Exceções

ArgumentException

O método não é estático.

- ou -

O tipo pai é uma interface.

- ou -

O método é abstrato.

- ou -

O método foi definido anteriormente.

- ou -

O comprimento de name, dllName ou entryName é zero.

- ou -

O tamanho de parameterTypeRequiredCustomModifiers ou parameterTypeOptionalCustomModifiers não é igual ao tamanho de parameterTypes.

ArgumentNullException

name, dllName ou entryName é null.

InvalidOperationException

O tipo foi criado anteriormente usando CreateType().

- ou -

Para o tipo dinâmico atual, a propriedade IsGenericType é true, mas a propriedade IsGenericTypeDefinition é false.

Exemplos

O exemplo de código a seguir demonstra como usar o DefinePInvokeMethod método para criar um PInvoke método e como adicionar o MethodImplAttributes.PreserveSig sinalizador aos sinalizadores de implementação do método depois de criar o MethodBuilder, usando os MethodBuilder.GetMethodImplementationFlags métodos e MethodBuilder.SetImplementationFlags .

O exemplo cria um assembly dinâmico com um módulo dinâmico e um único tipo, MyType, que contém o PInvoke método . O PInvoke método representa a função Win32 GetTickCount .

Importante

Para obter um valor retornado diferente de zero, você deve adicionar o MethodImplAttributes.PreserveSig sinalizador .

Nota

O exemplo usa uma sobrecarga que não especifica modificadores personalizados. Para especificar modificadores personalizados, altere o código de exemplo para usar essa sobrecarga de método.

Quando o exemplo é executado, ele executa o PInvoke método . Ele também salva o assembly dinâmico como PInvokeTest.dll. Você pode usar o Ildasm.exe (IL Disassembler) para examinar a MyType classe e o static método (Shared no Visual Basic) PInvoke que ela contém. Você pode compilar um programa do Visual Basic ou C# que usa o método estático MyType.GetTickCount incluindo uma referência à DLL ao executar csc.exe ou vbc.exe; por exemplo, /r:PInvokeTest.dll.

C#

using System;
using System.Text;
using System.Reflection;
using System.Reflection.Emit;
using System.Runtime.InteropServices;

public class Example
{
    public static void Main()
    {
        // Create the AssemblyBuilder.
        AssemblyName asmName = new AssemblyName("PInvokeTest");
        AssemblyBuilder dynamicAsm = AppDomain.CurrentDomain.DefineDynamicAssembly(
            asmName,
            AssemblyBuilderAccess.RunAndSave
        );

        // Create the module.
        ModuleBuilder dynamicMod =
            dynamicAsm.DefineDynamicModule(asmName.Name, asmName.Name + ".dll");

        // Create the TypeBuilder for the class that will contain the
        // signature for the PInvoke call.
        TypeBuilder tb = dynamicMod.DefineType(
            "MyType",
            TypeAttributes.Public | TypeAttributes.UnicodeClass
        );

        MethodBuilder mb = tb.DefinePInvokeMethod(
            "GetTickCount",
            "Kernel32.dll",
            MethodAttributes.Public | MethodAttributes.Static | MethodAttributes.PinvokeImpl,
            CallingConventions.Standard,
            typeof(int),
            Type.EmptyTypes,
            CallingConvention.Winapi,
            CharSet.Ansi);

        // Add PreserveSig to the method implementation flags. NOTE: If this line
        // is commented out, the return value will be zero when the method is
        // invoked.
        mb.SetImplementationFlags(
            mb.GetMethodImplementationFlags() | MethodImplAttributes.PreserveSig);

        // The PInvoke method does not have a method body.

        // Create the class and test the method.
        Type t = tb.CreateType();

        MethodInfo mi = t.GetMethod("GetTickCount");
        Console.WriteLine("Testing PInvoke method...");
        Console.WriteLine("GetTickCount returned: {0}", mi.Invoke(null, null));

        // Produce the .dll file.
        Console.WriteLine("Saving: " + asmName.Name + ".dll");
        dynamicAsm.Save(asmName.Name + ".dll");
    }
}

/* This example produces output similar to the following:

Testing PInvoke method...
GetTickCount returned: 1312576235
Saving: PInvokeTest.dll
 */

Comentários

Alguns atributos de importação de DLL (consulte a descrição de DllImportAttribute) não podem ser especificados como argumentos para esse método. Por exemplo, o atributo MethodImplAttributes.PreserveSig de importação de DLL deve ser adicionado depois que o PInvoke método é criado, se o método retorna um valor. O exemplo mostra como fazer isso.

Nota

Para obter mais informações sobre modificadores personalizados, consulte Padrões ECMA C# e Common Language Infrastructure e Standard ECMA-335 – Common Language Infrastructure (CLI).