MarshalAsAttribute Třída

Definice

Obor názvů:

System.Runtime.InteropServices

Sestavení:

System.Runtime.InteropServices.dll

Zdroj:

MarshalAsAttribute.cs

Určuje, jak zařakovat data 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 použije 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 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 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ů. Řetězec můžete například zařadovat do nespravovaného kódu jako LPStr, LPWStr, , LPTStrnebo BStr. Modul CLR (Common Language Runtime) ve výchozím nastavení zařadí řetězcový parametr jako do BStr metod modelu COM. Atribut můžete použít MarshalAsAttribute na jednotlivá pole nebo parametr, aby se daný řetězec zařadil jako zařazovaný LPStr místo BStr. Tlbexp.exe (exportér knihovny typů) předá vaše předvolby zařazování do modulu CLR (Common Language Runtime).

Některé parametry a návratové hodnoty mají při použití s voláním zprostředkovatele komunikace com nebo platformy odlišné výchozí chování zařazování. Ve výchozím nastavení modul runtime zařadí řetězcový parametr (a pole typu hodnoty) jako metodu LPStr 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. Pokud je například hodnota UnmanagedTypeLPArray. Úplný popis použití tohoto atributu s poli naleznete v tématu Výchozí zařazování pro pole.

Tlbimp.exe (Type Library Importer) také použije tento atribut u parametrů, polí a návratových hodnot, aby bylo možné určit, že datový typ v knihovně vstupních typů není výchozím typem pro odpovídající spravovaný datový typ. Tlbimp.exe vždy pro přehlednost používá MarshalAsAttribute na String typy a Object 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 nespravovaného LPArray prvku nebo ByValArray.
IidParameterIndex	Určuje index parametru nespravovaného iid_is atributu používaného objektem COM.
MarshalCookie	Poskytuje další informace k vlastnímu zařazování.
MarshalType	Určuje plně kvalifikovaný název vlastního zařazování.
MarshalTypeRef	Implementuje MarshalType jako typ.
SafeArraySubType	Označuje typ elementu SafeArray.
SafeArrayUserDefinedSubType	Označuje typ prvku definovaného uživatelem SafeArray.
SizeConst	Určuje počet prvků v matici s pevnou délkou nebo počet znaků (nikoli bajtů) v řetězci, který se má importovat.
SizeParamIndex	Určuje parametr založený na nule, který obsahuje počet prvků pole, podobně jako size_is v modelu COM.

Vlastnosti

TypeId	Při implementaci v odvozené třídě získá jedinečný identifikátor pro tuto Attributetřídu . (Zděděno od Attribute)
Value	UnmanagedType Získá hodnotu data, která mají být 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á z aktuální instance. (Zděděno od Object)
IsDefaultAttribute()	Při přepsání v odvozené třídě označuje, zda je hodnota této instance 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á označuje, zda se tato instance rovná zadanému objektu. (Zděděno od Attribute)
MemberwiseClone()	Vytvoří mělkou kopii aktuálního Objectsouboru . (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)