MarshalAsAttribute MarshalAsAttribute MarshalAsAttribute MarshalAsAttribute Class

Definition

Gibt an, wie die Daten zwischen verwaltetem und nicht verwaltetem Code gemarshallt werden sollen.Indicates how to marshal the data between managed and unmanaged code.

public ref class MarshalAsAttribute sealed : Attribute
[System.AttributeUsage(System.AttributeTargets.Field | System.AttributeTargets.Parameter | System.AttributeTargets.ReturnValue, Inherited=false)]
[System.Runtime.InteropServices.ComVisible(true)]
public sealed class MarshalAsAttribute : Attribute
type MarshalAsAttribute = class
    inherit Attribute
Public NotInheritable Class MarshalAsAttribute
Inherits Attribute
Vererbung
MarshalAsAttributeMarshalAsAttributeMarshalAsAttributeMarshalAsAttribute
Attribute

Beispiele

Im folgenden Beispiel wird die MarshalAsAttribute Wert um ein Feld, einen Methodenparameter und eine Methode in einem verwalteten Typ zurückgeben.The following example applies the MarshalAsAttribute to a field, a method parameter, and a method return value in a managed type.

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

Im folgenden Beispiel wird die MarshalAsAttribute -Attribut auf eine Eigenschaft:The following example applies the MarshalAsAttribute attribute to a property:

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

Hinweise

Sie können dieses Attribut anwenden, um Parameter und Felder zuzuordnen oder Werte zurückzugeben.You can apply this attribute to parameters, fields, or return values.

Dieses Attribut ist optional, da jeder Datentyp ein standardmäßiges Marshallingverhalten aufweist.This attribute is optional, as each data type has a default marshaling behavior. Dieses Attribut ist nur erforderlich, wenn Sie ein bestimmten Typ zu mehreren Typen gemarshallt werden kann.This attribute is only necessary when a given type can be marshaled to multiple types. Sie können z. B. eine Zeichenfolge, die nicht verwalteten Code als Marshallen einer LPStr, LPWStr, LPTStr, oder ein BStr.For example, you can marshal a string to unmanaged code as either a LPStr, a LPWStr, a LPTStr, or a BStr. In der Standardeinstellung marshallt die common Language Runtime einen Zeichenfolgenparameter als eine BStr von COM-Methoden.By default, the common language runtime marshals a string parameter as a BStr to COM methods. Sie anwenden können die MarshalAsAttribute -Attribut auf ein einzelnes Feld oder Parameter für diese bestimmte Zeichenfolge als gemarshallt werden, dazu führen, dass eine LPStr anstelle von einer BStr.You can apply the MarshalAsAttribute attribute to an individual field or parameter to cause that particular string to be marshaled as a LPStr instead of a BStr. Die Tlbexp.exe (Type Library Exporter-Tool) Ihre Marshallen Einstellungen für die common Language Runtime übergibt.The Tlbexp.exe (Type Library Exporter) passes your marshaling preferences to the common language runtime.

Einige Parameter und Rückgabewerte weisen ein anderes Verhalten bei der Verwendung mit COM-Interop-Marshalling oder Plattform aufgerufen.Some parameters and return values have different default marshaling behavior when used with COM interop or platform invoke. In der Standardeinstellung die Runtime marshallt einen Zeichenfolgenparameter (und Felder in einem Werttyp) als eine LPStr auf einer Plattform aufrufen, Methode oder Funktion.By default, the runtime marshals a string parameter (and fields in a value type) as a LPStr to a platform invoke method or function. Weitere Informationen finden Sie unter Default Marshaling Behavior.For additional information, see Default Marshaling Behavior.

In den meisten Fällen bestimmt das Attribut einfach das Format der nicht verwaltete Daten mithilfe der UnmanagedType Enumeration, wie in der folgenden C#-Signatur dargestellt:In most cases, the attribute simply identifies the format of the unmanaged data using the UnmanagedType enumeration, as shown in the following C# signature:

public void SomeMethod([MarshalAs(UnmanagedType.LPStr)] String s)
Public Sub SomeMethod(<MarshalAs(UnmanagedType.LPStr)> s As String)

Einige UnmanagedType Enumerationsmember sind zusätzliche Informationen erforderlich.Some UnmanagedType enumeration members require additional information. Zusätzliche Informationen ist erforderlich, z. B. wenn die UnmanagedType ist LPArray.For example, additional information is needed when the UnmanagedType is LPArray. Eine vollständige Beschreibung zur Verwendung dieses Attributs mit Arrays, finden Sie unter Standardmäßiges Marshalling für Arrays.For a complete description of how to use this attribute with arrays, see Default Marshaling for Arrays.

Die Tlbimp.exe (Type Library Importer-Tool) wendet dieses Attribut auch auf Parameter, Felder und Werte zurückgeben, um anzugeben, dass der Datentyp in der Bibliothek Eingabetyp nicht den Standardtyp für den entsprechenden verwalteten Datentyp ist.The Tlbimp.exe (Type Library Importer) also applies this attribute to parameters, fields, and return values to indicate that the data type in the input type library is not the default type for the corresponding managed data type. Tlbimp.exe immer gilt die MarshalAsAttribute zu String und Object Typen aus Gründen der Übersichtlichkeit, unabhängig von der Art, in der Typbibliothek für die Eingabe angegeben.Tlbimp.exe always applies the MarshalAsAttribute to String and Object types for clarity, regardless of the type specified in the input type library.

Hinweis

Die MarshalAsAttribute Marshalling von generischen Typen nicht unterstützt.The MarshalAsAttribute does not support marshaling of generic types.

Konstruktoren

MarshalAsAttribute(Int16) MarshalAsAttribute(Int16) MarshalAsAttribute(Int16) MarshalAsAttribute(Int16)

Initialisiert eine neue Instanz der MarshalAsAttribute-Klasse mit dem angegebenen UnmanagedType-Wert.Initializes a new instance of the MarshalAsAttribute class with the specified UnmanagedType value.

MarshalAsAttribute(UnmanagedType) MarshalAsAttribute(UnmanagedType) MarshalAsAttribute(UnmanagedType) MarshalAsAttribute(UnmanagedType)

Initialisiert eine neue Instanz der MarshalAsAttribute-Klasse mit dem angegebenen UnmanagedType-Enumerationsmember.Initializes a new instance of the MarshalAsAttribute class with the specified UnmanagedType enumeration member.

Felder

ArraySubType ArraySubType ArraySubType ArraySubType

Gibt den Elementtyp des nicht verwalteten LPArray oder ByValArray an.Specifies the element type of the unmanaged LPArray or ByValArray.

IidParameterIndex IidParameterIndex IidParameterIndex IidParameterIndex

Gibt den Parameterindex des nicht verwalteten iid_is-Attributs an, das von COM verwendet wird.Specifies the parameter index of the unmanaged iid_is attribute used by COM.

MarshalCookie MarshalCookie MarshalCookie MarshalCookie

Stellt zusätzliche Informationen für einen benutzerdefinierten Marshaller zur Verfügung.Provides additional information to a custom marshaler.

MarshalType MarshalType MarshalType MarshalType

Gibt den voll gekennzeichneten Namen eines benutzerdefinierten Marshallers an.Specifies the fully qualified name of a custom marshaler.

MarshalTypeRef MarshalTypeRef MarshalTypeRef MarshalTypeRef

Implementiert MarshalType als Typ.Implements MarshalType as a type.

SafeArraySubType SafeArraySubType SafeArraySubType SafeArraySubType

Gibt den Elementtyp von SafeArray an.Indicates the element type of the SafeArray.

SafeArrayUserDefinedSubType SafeArrayUserDefinedSubType SafeArrayUserDefinedSubType SafeArrayUserDefinedSubType

Gibt den benutzerdefinierten Elementtyp von SafeArray an.Indicates the user-defined element type of the SafeArray.

SizeConst SizeConst SizeConst SizeConst

Gibt die Anzahl der Elemente im Array fester Länger oder die Anzahl der Zeichen (nicht der Bytes) in einer zu importierenden Zeichenfolge an.Indicates the number of elements in the fixed-length array or the number of characters (not bytes) in a string to import.

SizeParamIndex SizeParamIndex SizeParamIndex SizeParamIndex

Gibt den nullbasierten Parameter an, der die Anzahl von Arrayelementen enthält, vergleichbar mit size_is in COM.Indicates the zero-based parameter that contains the count of array elements, similar to size_is in COM.

Eigenschaften

TypeId TypeId TypeId TypeId

Ruft bei Implementierung in einer abgeleiteten Klasse einen eindeutigen Bezeichner für dieses Attribute ab.When implemented in a derived class, gets a unique identifier for this Attribute.

(Inherited from Attribute)
Value Value Value Value

Ruft den UnmanagedType-Wert ab, als der die Daten gemarshallt werden sollen.Gets the UnmanagedType value the data is to be marshaled as.

Methoden

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

Gibt einen Wert zurück, der angibt, ob diese Instanz gleich einem angegebenen Objekt ist.Returns a value that indicates whether this instance is equal to a specified object.

(Inherited from Attribute)
GetHashCode() GetHashCode() GetHashCode() GetHashCode()

Gibt den Hashcode für diese Instanz zurück.Returns the hash code for this instance.

(Inherited from Attribute)
GetType() GetType() GetType() GetType()

Ruft den Type der aktuellen Instanz ab.Gets the Type of the current instance.

(Inherited from Object)
IsDefaultAttribute() IsDefaultAttribute() IsDefaultAttribute() IsDefaultAttribute()

Gibt beim Überschreiben in einer abgeleiteten Klasse an, ob der Wert der Instanz der Standardwert für die abgeleitete Klasse ist.When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class.

(Inherited from Attribute)
Match(Object) Match(Object) Match(Object) Match(Object)

Beim Überschreiben in einer abgeleiteten Klasse wird ein Wert zurückgegeben, der angibt, ob diese Instanz einem bestimmten Objekt entspricht.When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.

(Inherited from Attribute)
MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

Erstellt eine flache Kopie des aktuellen Object.Creates a shallow copy of the current Object.

(Inherited from Object)
ToString() ToString() ToString() ToString()

Gibt eine Zeichenfolge zurück, die das aktuelle Objekt darstellt.Returns a string that represents the current object.

(Inherited from Object)

Explizite Schnittstellenimplementierungen

_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr) _Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr) _Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr) _Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)

Ordnet eine Reihe von Namen einer entsprechenden Reihe von Dispatchbezeichnern zu.Maps a set of names to a corresponding set of dispatch identifiers.

(Inherited from Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) _Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) _Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) _Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)

Ruft die Typinformationen für ein Objekt ab, mit deren Hilfe die Typinformationen für eine Schnittstelle abgerufen werden können.Retrieves the type information for an object, which can be used to get the type information for an interface.

(Inherited from Attribute)
_Attribute.GetTypeInfoCount(UInt32) _Attribute.GetTypeInfoCount(UInt32) _Attribute.GetTypeInfoCount(UInt32) _Attribute.GetTypeInfoCount(UInt32)

Ruft die Anzahl der Schnittstellen mit Typinformationen ab, die von einem Objekt bereitgestellt werden (0 oder 1).Retrieves the number of type information interfaces that an object provides (either 0 or 1).

(Inherited from Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) _Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) _Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) _Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

Stellt den Zugriff auf von einem Objekt verfügbar gemachte Eigenschaften und Methoden bereit.Provides access to properties and methods exposed by an object.

(Inherited from Attribute)

Gilt für:

Siehe auch