MarshalAsAttribute Třída

Definice

Obor názvů:

System.Runtime.InteropServices

Sestavení:

netstandard.dll, System.Runtime.InteropServices.dll

Zdroj:

MarshalAsAttribute.cs

Označuje, jak zařazení dat mezi spravovaným a nespravovaným kódem.

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

Dědičnost

Object

Attribute

MarshalAsAttribute

Atributy

AttributeUsageAttribute

Příklady

Následující příklad se vztahuje MarshalAsAttribute na pole, parametr metody a návratovou hodnotu metody ve spravovaném typu.

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

Následující příklad aplikuje MarshalAsAttribute atribut na vlastnost:

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

Poznámky

Tento atribut můžete použít na parametry, pole nebo návratové hodnoty.

Tento atribut je volitelný, protože každý datový typ má výchozí chování zařazování. Tento atribut je nezbytný pouze v případě, že daný typ lze zařazovat do více typů. Můžete například zařadovat řetězec do nespravovaného kódu jako LPStr, a LPWStr, a LPTStr, nebo BStr. Modul CLR (Common Language Runtime) ve výchozím nastavení zařadí parametr řetězce jako BStr metody modelu COM. Atribut můžete použít MarshalAsAttribute na jednotlivá pole nebo parametr, aby byl daný řetězec zařazován jako LPStr místo BStr. Tlbexp.exe (exportér knihovny typů) předá předvolby zařazování do modulu CLR (Common Language Runtime).

Některé parametry a návratové hodnoty mají jiné výchozí zařazování chování při použití s voláním zprostředkovatele komunikace com nebo platformy. Modul runtime ve výchozím nastavení zařadí parametr řetězce (a pole v typu hodnoty) jako LPStr metodu nebo funkci vyvolání platformy. Další informace najdete v tématu Výchozí chování zařazování.

Ve většině případů atribut jednoduše identifikuje formát nespravovaných dat pomocí výčtu UnmanagedType , jak je znázorněno v následujícím podpisu jazyka C#:

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

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

Některé UnmanagedType členy výčtu vyžadují další informace. Například další informace jsou potřeba v případě, že je UnmanagedType.LPArray Úplný popis použití tohoto atributu s poli naleznete v tématu Výchozí zařazování polí.

Tento atributTlbimp.exe (importér knihovny typů) použije také na parametry, pole a návratové hodnoty, které označují, že datový typ v knihovně vstupních typů není výchozím typem odpovídajícího spravovaného datového typu. Tlbimp.exe vždy platí pro MarshalAsAttributeString srozumitelnost a Object typy bez ohledu na typ zadaný v knihovně vstupních typů.

Note

Nepodporuje MarshalAsAttribute zařazování obecných typů.

Konstruktory

Name	Description
MarshalAsAttribute(Int16)	Inicializuje novou instanci MarshalAsAttribute třídy se zadanou UnmanagedType hodnotou.
MarshalAsAttribute(UnmanagedType)	Inicializuje novou instanci MarshalAsAttribute třídy se zadaným UnmanagedType členem výčtu.

Pole

Name	Description
ArraySubType	Určuje typ prvku nespravovaného LPArray nebo ByValArray.
IidParameterIndex	Určuje index parametrů nespravovaného iid_is atributu, který používá com.
MarshalCookie	Poskytuje další informace pro vlastní zařazovač.
MarshalType	Určuje plně kvalifikovaný název vlastního zařazovače.
MarshalTypeRef	Implementuje MarshalType jako typ.
SafeArraySubType	Označuje typ SafeArrayprvku .
SafeArrayUserDefinedSubType	Označuje uživatelem definovaný typ elementu SafeArray.
SizeConst	Určuje počet prvků v poli s pevnou délkou nebo počet znaků (nikoli bajtů) v řetězci, který se má importovat.
SizeParamIndex	Označuje parametr založený na nule, který obsahuje počet prvků pole, podobně jako size_is v modelu COM.

Vlastnosti

Name	Description
TypeId	Při implementaci v odvozené třídě získá jedinečný identifikátor pro tento Attribute. (Zděděno od Attribute)
Value	UnmanagedType Získá hodnotu, která má být data zařazována jako.

Metody

Name	Description
Equals(Object)	Vrátí hodnotu, která určuje, zda je tato instance rovna zadanému objektu. (Zděděno od Attribute)
GetHashCode()	Vrátí kód hash pro tuto instanci. (Zděděno od Attribute)
GetType()	Získá Type aktuální instance. (Zděděno od Object)
IsDefaultAttribute()	Při přepsání v odvozené třídě určuje, zda hodnota této instance je výchozí hodnotou pro odvozenou třídu. (Zděděno od Attribute)
Match(Object)	Při přepsání v odvozené třídě vrátí hodnotu, která určuje, zda se tato instance rovná zadanému objektu. (Zděděno od Attribute)
MemberwiseClone()	Vytvoří mělkou kopii aktuálního Object. (Zděděno od Object)
ToString()	Vrátí řetězec, který představuje aktuální objekt. (Zděděno od Object)

Viz také

• UnmanagedType
• Exportér knihovny typů (Tlbexp.exe)
• Import knihovny typů (Tlbimp.exe)