Clase PreserveSigAttribute

 

Publicado: julio de 2016

Indica que el valor HRESULT o retval se debe suprimir la transformación de la firma que tiene lugar durante las llamadas de interoperabilidad COM.

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

Jerarquía de herencia

System.Object
  System.Attribute
    System.Runtime.InteropServices.PreserveSigAttribute

Sintaxis

[AttributeUsageAttribute(AttributeTargets.Method, Inherited = false)]
[ComVisibleAttribute(true)]
public sealed class PreserveSigAttribute : Attribute

[AttributeUsageAttribute(AttributeTargets::Method, Inherited = false)]
[ComVisibleAttribute(true)]
public ref class PreserveSigAttribute sealed : Attribute

[<Sealed>]
[<AttributeUsageAttribute(AttributeTargets.Method, Inherited = false)>]
[<ComVisibleAttribute(true)>]
type PreserveSigAttribute = 
    class
        inherit Attribute
    end

<AttributeUsageAttribute(AttributeTargets.Method, Inherited := False)>
<ComVisibleAttribute(True)>
Public NotInheritable Class PreserveSigAttribute
    Inherits Attribute

Constructores

	Nombre	Descripción
	PreserveSigAttribute()	Inicializa una nueva instancia de la clase PreserveSigAttribute.

Propiedades

	Nombre	Descripción
	TypeId	Cuando se implementa en una clase derivada, obtiene un identificador único para este Attribute.(Heredado de Attribute).

Métodos

	Nombre	Descripción
	Equals(Object)	Esta API admite la infraestructura producto y no está diseñada para usarse directamente desde el código. Devuelve un valor que indica si esta instancia es igual que un objeto especificado.(Heredado de Attribute).
	GetHashCode()	Devuelve el código hash de esta instancia.(Heredado de Attribute).
	GetType()	Obtiene el Type de la instancia actual.(Heredado de Object).
	IsDefaultAttribute()	Si se reemplaza en una clase derivada, indica si el valor de esta instancia es el valor predeterminado de la clase derivada.(Heredado de Attribute).
	Match(Object)	Cuando se invalida en una clase derivada, devuelve un valor que indica si esta instancia es igual a un objeto especificado.(Heredado de Attribute).
	ToString()	Devuelve una cadena que representa el objeto actual.(Heredado de Object).

Implementaciones de interfaz explícitas

	Nombre	Descripción
	_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)	Asigna un conjunto de nombres a un conjunto correspondiente de identificadores de envío.(Heredado de Attribute).
	_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)	Obtiene la información de tipos de un objeto, que puede utilizarse para obtener la información de tipos de una interfaz.(Heredado de Attribute).
	_Attribute.GetTypeInfoCount(UInt32)	Recupera el número de interfaces de información de tipo que proporciona un objeto (0 ó 1).(Heredado de Attribute).
	_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)	Proporciona acceso a las propiedades y los métodos expuestos por un objeto.(Heredado de Attribute).

Comentarios

Este atributo se puede aplicar a métodos.

De forma predeterminada, la Tlbexp.exe (Type Library Exporter) garantiza que una llamada que devuelve un valor HRESULT de S_OK se transforma que [out, retval] parámetro se utiliza como el valor devuelto de función. El valor de HRESULT S_OK se descarta. Para valores HRESULT distinto de S_OK, el tiempo de ejecución produce una excepción y descarta el [out, retval] parámetro. Al aplicar el PreserveSigAttribute a una firma de método administrado, las firmas no administradas y no administrado del método con atributos son idénticas.

Es necesario conservar la firma del método original si el miembro devuelve más de un valor HRESULT correcto y que desea detectar los distintos valores. Puesto que la mayoría miembro COM devuelven un valor de HRESULT, aplicando la PreserveSigAttribute, puede recuperar un entero que representa el éxito o error HRESULT. Tlbexp.exe conserva cualquier [out, retval] parámetros como parámetros out en la firma administrada.

El Tlbimp.exe (Type Library Importer) también se aplica este atributo; se aplica el atributo a interfaces dispinterface cuando importa una biblioteca de tipos.

Nota

Devolver tipos de Currency, Guid, y Object no son compatibles con el PreserveSigAttribute clase cuando se produce interoperación de COM a código administrado y el código administrado se marca con la PreserveSigAttribute clase. Al intentar usar uno de estos tipos de valor devuelto con el PreserveSigAttribute clase durante estas condiciones, un TypeLoadException se produce.

Ejemplos

En el ejemplo siguiente se muestra cómo Tlbexp.exe convierte un método de C# sin PreserveSigAttribute al exportar un ensamblado a una biblioteca de tipos COM.

Firma administrada:

int DoSomething (long l);

Prototipo no administrado:

HRESULT DoSomething ([in] long l, [out, retval] int * i);

Al aplicar PreserveSigAttribute en el mismo método de C# y el ensamblado de exportación, la conversión del método difiere del ejemplo anterior. Observe que Tlbexp.exe quita el valor HRESULT y el [out, retval] modificador de parámetro.

Firma administrada:

[PreserveSig] int DoSomething (long l);

Prototipo no administrado:

int DoSomething ([in] long l);

Información de versión

Plataforma universal de Windows
Disponible desde 8
.NET Framework
Disponible desde 1.1
Biblioteca de clases portable
Se admite en: plataformas portátiles de .NET
Silverlight
Disponible desde 2.0
Windows Phone Silverlight
Disponible desde 7.0
Windows Phone
Disponible desde 8.1

Seguridad para subprocesos

Cualquier miembro ( Compartido en Visual Basic) estático público de este tipo es seguro para subprocesos. No se garantiza que los miembros de instancia sean seguros para subprocesos.

Ver también

Espacio de nombres System.Runtime.InteropServices
Tlbexp.exe (Type Library Exporter)
Tlbimp.exe (Type Library Importer)

Volver al principio