MarshalAsAttribute Třída

Definice

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)]
[System.Runtime.InteropServices.ComVisible(true)]
public sealed class MarshalAsAttribute : Attribute
[<System.AttributeUsage(System.AttributeTargets.Field | System.AttributeTargets.Parameter | System.AttributeTargets.ReturnValue, Inherited=false)>]
type MarshalAsAttribute = class
    inherit Attribute
[<System.AttributeUsage(System.AttributeTargets.Field | System.AttributeTargets.Parameter | System.AttributeTargets.ReturnValue, Inherited=false)>]
[<System.Runtime.InteropServices.ComVisible(true)>]
type MarshalAsAttribute = class
    inherit Attribute
Public NotInheritable Class MarshalAsAttribute
Inherits Attribute
Dědičnost
MarshalAsAttribute
Atributy

Příklady

Následující příklad použije MarshalAsAttribute 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 použije 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 u parametrů, polí nebo návratových hodnot.

Tento atribut je volitelný, protože každý datový typ má výchozí chování zařazování. Tento atribut je nutný pouze v případě, že daný typ lze zařazovat do více typů. Můžete například zařadit řetězec na nespravovaný kód jako , LPStra , LPWStra , LPTStrnebo BStr. Modul CLR (Common Language Runtime) ve výchozím nastavení zařazuje 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 místo LPStr BStr. Tlbexp.exe (exportér knihovny typů) předává vaše předvolby zařazování do modulu clr 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 modelu COM nebo platformy. Modul runtime ve výchozím nastavení zařazuje 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 UnmanagedType je LPArray. Úplný popis použití tohoto atributu s poli najdete v tématu Výchozí zařazování polí.

Tento atribut Tlbimp.exe (Type Library Importer) se vztahuje 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 MarshalAsAttribute String srozumitelnost a Object typy bez ohledu na typ zadaný v knihovně vstupních typů.

Poznámka

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

Konstruktory

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

ArraySubType

Určuje typ prvku nespravovaného LPArray nebo ByValArray.

IidParameterIndex

Určuje index parametrů nespravovaného iid_is atributu používaného objektem COM.

MarshalCookie

Poskytuje další informace pro vlastní zařazování.

MarshalType

Určuje plně kvalifikovaný název vlastního zařazování.

MarshalTypeRef

Implementuje MarshalType se jako typ.

SafeArraySubType

Označuje typ prvku .SafeArray

SafeArrayUserDefinedSubType

Označuje typ uživatelem definovaného SafeArrayprvku .

SizeConst

Označuje počet prvků v poli s pevnou délkou nebo počet znaků (nikoli bajty) 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 u modelu COM.

Vlastnosti

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

Equals(Object)

Vrací hodnotu, která určuje, zda je tato instance rovna zadanému objektu.

(Zděděno od Attribute)
GetHashCode()

Vrátí hodnotu hash pro tuto instanci.

(Zděděno od Attribute)
GetType()

Type Získá aktuální instanci.

(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 odvozené třídy.

(Zděděno od Attribute)
Match(Object)

Při přepsání v odvozené třídě vrátí hodnotu, která označuje, zda se tato instance rovná zadanému objektu.

(Zděděno od Attribute)
MemberwiseClone()

Vytvoří použádnou kopii aktuálního souboru Object.

(Zděděno od Object)
ToString()

Vrátí řetězec, který představuje aktuální objekt.

(Zděděno od Object)

Explicitní implementace rozhraní

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

Mapuje sadu názvů na odpovídající sadu identifikátorů pro rozesílání.

(Zděděno od Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)

Načte informace o typu objektu, který lze použít k získání informací o typu rozhraní.

(Zděděno od Attribute)
_Attribute.GetTypeInfoCount(UInt32)

Získá počet rozhraní typu informací, které objekt poskytuje (0 nebo 1).

(Zděděno od Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

Poskytuje přístup k vlastnostem a metodám vystaveným objektem.

(Zděděno od Attribute)

Platí pro

Viz také