MarshalAsAttribute Classe

Definição

Namespace:

System.Runtime.InteropServices

Assembly:

System.Runtime.InteropServices.dll

Origem:

MarshalAsAttribute.cs

Indica como realizar marshaling de dados entre código gerenciado e não gerenciado.

public ref class MarshalAsAttribute sealed : Attribute

[System.AttributeUsage(System.AttributeTargets.Field | System.AttributeTargets.Parameter | System.AttributeTargets.ReturnValue, Inherited=false)]
public sealed class MarshalAsAttribute : Attribute

[<System.AttributeUsage(System.AttributeTargets.Field | System.AttributeTargets.Parameter | System.AttributeTargets.ReturnValue, Inherited=false)>]
type MarshalAsAttribute = class
    inherit Attribute

Public NotInheritable Class MarshalAsAttribute
Inherits Attribute

Herança

Object

Attribute

MarshalAsAttribute

Atributos

AttributeUsageAttribute

Exemplos

O exemplo a seguir aplica o MarshalAsAttribute a um campo, um parâmetro de método e um valor de retorno de método em um tipo gerenciado.

using System;
using System.Text;
using System.Runtime.InteropServices;

class Program
{

//Applied to a parameter.
  public void M1([MarshalAs(UnmanagedType.LPWStr)]String msg) {}

//Applied to a field within a class.
  class MsgText {
                [MarshalAs(UnmanagedType.LPWStr)]
                public String msg = "Hello World";
                }

//Applied to a return value.
[return: MarshalAs(UnmanagedType.LPWStr)]
    public String GetMessage()
    {
        return "Hello World";
    }

static void Main(string[] args)
    {  }
}

Imports System.Runtime.InteropServices

Module Module1

    Sub Main()

    End Sub

    'Applied to a parameter.
    Public Sub M1(<MarshalAsAttribute(UnmanagedType.LPWStr)> ByVal msg As String)
        msg = msg + "Goodbye"
    End Sub

    'Applied to a field within a class.
    Class MsgText
        <MarshalAsAttribute(UnmanagedType.LPWStr)> Public msg As String
    End Class

    'Applied to a return value.
    Public Function M2() As <MarshalAsAttribute(UnmanagedType.LPWStr)> String
        Return "Hello World"
    End Function

End Module

O exemplo a seguir aplica o MarshalAsAttribute atributo a uma propriedade :

decimal _money;   

public decimal Money 
{
   [return: MarshalAs(UnmanagedType.Currency)]
   get { return this._money; }
   [param: MarshalAs(UnmanagedType.Currency)]
   set { this._money = value; }
}

Dim _money As Decimal   

Public Property Money As <MarshalAs(UnmanagedType.Currency)> Decimal 
   Get
      Return Me._money
   End Get
   Set(<MarshalAs(UnmanagedType.Currency)> value As Decimal)
      Me._money = value
   End Set   
End Property

Comentários

Você pode aplicar esse atributo a parâmetros, campos ou valores retornados.

Esse atributo é opcional, pois cada tipo de dados tem um comportamento de marshaling padrão. Esse atributo só é necessário quando um determinado tipo pode ser empacotado em vários tipos. Por exemplo, você pode realizar marshaling de uma cadeia de caracteres para código não gerenciado como um LPStr, um LPWStr, um LPTStrou um BStr. Por padrão, o Common Language Runtime realiza marshaling de um parâmetro de cadeia de caracteres como um BStr para métodos COM. Você pode aplicar o MarshalAsAttribute atributo a um campo ou parâmetro individual para fazer com que essa cadeia de caracteres específica seja empacotada como um LPStr em vez de um BStr. O Tlbexp.exe (Exportador da Biblioteca de Tipos) passa suas preferências de marshaling para o Common Language Runtime.

Alguns parâmetros e valores retornados têm um comportamento de marshaling padrão diferente quando usados com interoperabilidade COM ou invocação de plataforma. Por padrão, o runtime realiza marshaling de um parâmetro de cadeia de caracteres (e campos em um tipo de valor) como um para um LPStr método ou função de invocação de plataforma. Para obter informações adicionais, consulte Comportamento de marshaling padrão.

Na maioria dos casos, o atributo simplesmente identifica o formato dos dados não gerenciados usando a UnmanagedType enumeração, conforme mostrado na seguinte assinatura C#:

public void SomeMethod([MarshalAs(UnmanagedType.LPStr)] String s)

Public Sub SomeMethod(<MarshalAs(UnmanagedType.LPStr)> s As String)

Alguns UnmanagedType membros de enumeração exigem informações adicionais. Por exemplo, informações adicionais são necessárias quando o UnmanagedType é LPArray. Para obter uma descrição completa de como usar esse atributo com matrizes, consulte Marshaling Padrão para Matrizes.

O Tlbimp.exe (Importador de Biblioteca de Tipos) também aplica esse atributo a parâmetros, campos e valores retornados para indicar que o tipo de dados na biblioteca de tipos de entrada não é o tipo padrão para o tipo de dados gerenciado correspondente. Tlbimp.exe sempre aplica os MarshalAsAttributeString tipos e Object para maior clareza, independentemente do tipo especificado na biblioteca de tipos de entrada.

Observação

O MarshalAsAttribute não dá suporte ao marshaling de tipos genéricos.

Construtores

MarshalAsAttribute(Int16)	Inicializa uma nova instância da classe MarshalAsAttribute com o valor UnmanagedType especificado.
MarshalAsAttribute(UnmanagedType)	Inicializa uma nova instância da classe MarshalAsAttribute com o membro de enumeração UnmanagedType especificado.

Campos

ArraySubType	Especifica o tipo de elemento do LPArray não gerenciado ou ByValArray.
IidParameterIndex	Especifica o índice do parâmetro do atributo iid_is não gerenciado usado por COM.
MarshalCookie	Fornece informações adicionais para um marshaler personalizado.
MarshalType	Especifica o nome totalmente qualificado de um marshaler personalizado.
MarshalTypeRef	Implementa MarshalType como um tipo.
SafeArraySubType	Indica o tipo de elemento de SafeArray.
SafeArrayUserDefinedSubType	Indica o tipo de elemento definido pelo usuário do SafeArray.
SizeConst	Indica o número de elementos na matriz de comprimento fixo ou o número de caracteres (não em bytes) em uma cadeia de caracteres a importar.
SizeParamIndex	Indica o parâmetro baseado em zero que contém a contagem de elementos da matriz, semelhante a size_is em COM.

Propriedades

TypeId	Quando implementado em uma classe derivada, obtém um identificador exclusivo para este Attribute. (Herdado de Attribute)
Value	Obtém o valor UnmanagedType como o qual deve ser realizado o mashal dos dados.

Métodos

Equals(Object)	Retorna um valor que indica se essa instância é igual a um objeto especificado. (Herdado de Attribute)
GetHashCode()	Retorna o código hash para a instância. (Herdado de Attribute)
GetType()	Obtém o Type da instância atual. (Herdado de Object)
IsDefaultAttribute()	Quando substituído em uma classe derivada, indica se o valor dessa instância é o valor padrão para a classe derivada. (Herdado de Attribute)
Match(Object)	Quando substituído em uma classe derivada, retorna um valor que indica se essa instância é igual a um objeto especificado. (Herdado de Attribute)
MemberwiseClone()	Cria uma cópia superficial do Object atual. (Herdado de Object)
ToString()	Retorna uma cadeia de caracteres que representa o objeto atual. (Herdado de Object)

Confira também

• UnmanagedType
• Exportador de Biblioteca de Tipos (Tlbexp.exe)
• Importador de Biblioteca de Tipos (Tlbimp.exe)