System.Runtime.InteropServi ...


Biblioteca de clases de .NET Framework
MarshalAsAttribute (Clase)

Actualización: noviembre 2007

Indica la forma de calcular las referencias de los datos entre el código administrado y el código no administrado.

Espacio de nombres:  System.Runtime.InteropServices
Ensamblado:  mscorlib (en mscorlib.dll)
Sintaxis

Visual Basic (Declaración)
<ComVisibleAttribute(True)> _
<AttributeUsageAttribute(AttributeTargets.Field Or AttributeTargets.Parameter Or AttributeTargets.ReturnValue, Inherited := False)> _
Public NotInheritable Class MarshalAsAttribute _
    Inherits Attribute
Visual Basic (Uso)
Dim instance As MarshalAsAttribute
C#
[ComVisibleAttribute(true)]
[AttributeUsageAttribute(AttributeTargets.Field|AttributeTargets.Parameter|AttributeTargets.ReturnValue, Inherited = false)]
public sealed class MarshalAsAttribute : Attribute
Visual C++
[ComVisibleAttribute(true)]
[AttributeUsageAttribute(AttributeTargets::Field|AttributeTargets::Parameter|AttributeTargets::ReturnValue, Inherited = false)]
public ref class MarshalAsAttribute sealed : public Attribute
J#
/** @attribute ComVisibleAttribute(true) */
/** @attribute AttributeUsageAttribute(AttributeTargets.Field|AttributeTargets.Parameter|AttributeTargets.ReturnValue, Inherited = false) */
public final class MarshalAsAttribute extends Attribute
JScript
public final class MarshalAsAttribute extends Attribute
Comentarios

Este atributo se puede aplicar a parámetros, campos o valores devueltos.

Este atributo es opcional ya que cada tipo de datos tiene un comportamiento predeterminado para el cálculo de referencias. Este atributo sólo es necesario cuando las referencias de un determinado tipo pueden calcularse para varios tipos. Por ejemplo, las referencias de una cadena al código no administrado pueden calcularse como LPStr, LPWStr, LPTStr o BStr. De forma predeterminada, Common Language Runtime calcula las referencias de un parámetro de cadena como BStr para los métodos COM. El atributo MarshalAsAttribute puede aplicarse a un campo o a un parámetro individual para hacer que las referencias de una cadena determinada se calculen como LPStr en lugar de BStr. Exportador de la biblioteca de tipos (Tlbexp.exe) pasa las preferencias del cálculo de referencias a Common Language Runtime.

Algunos parámetros y valores devueltos tienen un comportamiento predeterminado distinto en lo que se refiere al cálculo de referencias si se utilizan con interoperabilidad COM o con invocación de plataforma. De forma predeterminada, el motor en tiempo de ejecución calcula las referencias de un parámetro de cadena (y los campos de un tipo de valor) como LPStr para un método o función de invocación de plataforma. Para obtener más información, vea Comportamiento predeterminado del cálculo de referencias.

En la mayoría de los casos, el atributo identifica simplemente el formato de los datos no administrados utilizando la enumeración UnmanagedType, tal y como se muestra en la siguiente firma de C#:

void
    MyMethod([MarshalAs(LPStr)] String s);

Algunos miembros de enumeración UnmanagedType requieren más información. Por ejemplo, se necesita más información cuando UnmanagedType es LPArray. Para obtener una descripción completa de la forma de utilizar este atributo con matrices, vea Cálculo de referencias predeterminado para matrices.

Importador de la biblioteca de tipos (TlbImp.exe) también aplica este atributo a parámetros, campos y valores devueltos para indicar que el tipo de datos de la biblioteca de tipos de entrada no es el tipo predeterminado del tipo de datos administrado correspondiente. Tlbimp.exe siempre aplica MarshalAsAttribute a los tipos String y Object por cuestiones de claridad, independientemente del tipo especificado en la biblioteca de tipos de entrada.

t167a1e9.alert_note(es-es,VS.90).gifNota:

MarshalAsAttribute no admite el cálculo de referencias de tipos genéricos.

Ejemplos

En los siguientes ejemplos se muestra la ubicación de MarshalAsAttribute en el código fuente administrado, tal y como se aplica a parámetros, campos y valores devueltos.

Visual Basic
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 a return value.
    Public Function M2() As <MarshalAsAttribute(UnmanagedType.LPWStr)> String
        Return "Hello World"
    End Function

End Module
C#
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)
    {  }
}
Jerarquía de herencia

System..::.Object
  System..::.Attribute
    System.Runtime.InteropServices..::.MarshalAsAttribute
Seguridad para subprocesos

Todos los miembros static (Shared en Visual Basic) públicos de este tipo son seguros para la ejecución de subprocesos. No se garantiza que los miembros de instancias sean seguros para la ejecución de subprocesos.
Plataformas

Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98, Windows CE, Windows Mobile para Smartphone, Windows Mobile para Pocket PC, Xbox 360

.NET Framework y .NET Compact Framework no admiten todas las versiones de cada plataforma. Para obtener una lista de las versiones compatibles, vea Requisitos de sistema de .NET Framework.
Información de versión

.NET Framework

Compatible con: 3.5, 3.0, 2.0, 1.1, 1.0

.NET Compact Framework

Compatible con: 3.5, 2.0

XNA Framework

Compatible con: 2.0, 1.0
Vea también

Referencia

Otros recursos

Etiquetas :


Page view tracker