PreserveSigAttribute Class

Definition

Показывает, что преобразование значения HRESULT или сигнатуры retval, происходящее в процессе вызовов COM-взаимодействия, следует запретить.Indicates that the HRESULT or retval signature transformation that takes place during COM interop calls should be suppressed.

public ref class PreserveSigAttribute sealed : Attribute
[System.AttributeUsage(System.AttributeTargets.Method, Inherited=false)]
public sealed class PreserveSigAttribute : Attribute
[System.AttributeUsage(System.AttributeTargets.Method, Inherited=false)]
[System.Runtime.InteropServices.ComVisible(true)]
public sealed class PreserveSigAttribute : Attribute
type PreserveSigAttribute = class
    inherit Attribute
Public NotInheritable Class PreserveSigAttribute
Inherits Attribute
Inheritance
PreserveSigAttribute
Attributes

Examples

В следующем примере показано, C# как программа Tlbexp. exe преобразует метод без PreserveSigAttribute при экспорте сборки в БИБЛИОТЕКУ типов COM.The following example shows how Tlbexp.exe converts a C# method without PreserveSigAttribute when exporting an assembly to a COM type library.

Управляемая сигнатура:Managed signature:

int DoSomething (long l);  

Неуправляемая подпись:Unmanaged signature:

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

При применении PreserveSigAttribute к тому же C# методу и экспорту сборки, преобразование метода отличается от предыдущего примера.When you apply PreserveSigAttribute to the same C# method and export the assembly, the method conversion differs from the previous example. Обратите внимание, что программа Tlbexp. exe удаляет значения HRESULT и модификатор параметра [out, retval].Notice that Tlbexp.exe removes the HRESULT and the [out, retval] parameter modifier.

Управляемая сигнатура:Managed signature:

[PreserveSig] int DoSomething (long l);  

Неуправляемая подпись:Unmanaged signature:

int DoSomething ([in] long l);  

Remarks

Этот атрибут можно применить к методам.You can apply this attribute to methods.

По умолчанию программа Tlbexp. exe (программа экспорта библиотек типов) гарантирует, что вызов, возвращающий значение HRESULT S_OK, преобразуется таким образом, что параметр [out, retval] используется в качестве возвращаемого значения функции.By default, the Tlbexp.exe (Type Library Exporter) ensures that a call that returns an HRESULT of S_OK is transformed such that the [out, retval] parameter is used as the function return value. S_OK HRESULT отбрасывается.The S_OK HRESULT is discarded. Для значений HRESULT, отличных от S_OK, среда выполнения создает исключение и отменяет параметр [out, retval].For HRESULTs other than S_OK, the runtime throws an exception and discards the [out, retval] parameter. При применении PreserveSigAttribute к сигнатуре управляемого метода, управляемые и неуправляемые сигнатуры метода с атрибутами идентичны.When you apply the PreserveSigAttribute to a managed method signature, the managed and unmanaged signatures of the attributed method are identical.

Сохранение сигнатуры исходного метода необходимо, если элемент возвращает более одного значения HRESULT успешного выполнения и требуется обнаружить различные значения.Preserving the original method signature is necessary if the member returns more than one success HRESULT value and you want to detect the different values. Поскольку большинство COM-элементов возвращают HRESULT, применяя PreserveSigAttribute, можно получить целое число, представляющее значение HRESULT об успешном или неудачном выполнении.Since most COM member return an HRESULT, by applying the PreserveSigAttribute, you can retrieve an integer representing the success or failure HRESULT. Программа Tlbexp. exe сохраняет все параметры [out, retval] в качестве параметров out в управляемой сигнатуре.Tlbexp.exe preserves any [out, retval] parameters as out parameters in the managed signature.

Средство Tlbimp. exe (программа импорта библиотек типов) также применяет этот атрибут; Он применяет атрибут к disp-интерфейсам при импорте библиотеки типов.The Tlbimp.exe (Type Library Importer) also applies this attribute; it applies the attribute to dispinterfaces when it imports a type library.

Note

Типы возвращаемых данных Currency, Guidи Object не поддерживаются классом PreserveSigAttribute, когда происходит взаимодействие из COM в управляемый код, а управляемый код помечается классом PreserveSigAttribute.Return types of Currency, Guid, and Object are not supported by the PreserveSigAttribute class when interoperation occurs from COM to managed code and the managed code is marked with the PreserveSigAttribute class. При попытке использовать один из этих возвращаемых типов с классом PreserveSigAttribute в этих условиях создается TypeLoadException.When you attempt to use one of these return types with the PreserveSigAttribute class during these conditions, a TypeLoadException is thrown.

Constructors

PreserveSigAttribute()

Инициализирует новый экземпляр класса PreserveSigAttribute.Initializes a new instance of the PreserveSigAttribute class.

Properties

TypeId

В случае реализации в производном классе возвращает уникальный идентификатор для этого атрибута Attribute.When implemented in a derived class, gets a unique identifier for this Attribute.

(Inherited from Attribute)

Methods

Equals(Object)

Возвращает значение, показывающее, равен ли экземпляр указанному объекту.Returns a value that indicates whether this instance is equal to a specified object.

(Inherited from Attribute)
GetHashCode()

Возвращает хэш-код для этого экземпляра.Returns the hash code for this instance.

(Inherited from Attribute)
GetType()

Возвращает объект Type для текущего экземпляра.Gets the Type of the current instance.

(Inherited from Object)
IsDefaultAttribute()

При переопределении в производном классе указывает, является ли значение этого экземпляра значением по умолчанию для производного класса.When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class.

(Inherited from Attribute)
Match(Object)

При переопределении в производном классе возвращает значение, указывающее, является ли этот экземпляр равным заданному объекту.When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.

(Inherited from Attribute)
MemberwiseClone()

Создает неполную копию текущего объекта Object.Creates a shallow copy of the current Object.

(Inherited from Object)
ToString()

Возвращает строку, представляющую текущий объект.Returns a string that represents the current object.

(Inherited from Object)

Explicit Interface Implementations

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

Сопоставляет набор имен соответствующему набору идентификаторов диспетчеризации.Maps a set of names to a corresponding set of dispatch identifiers.

(Inherited from Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)

Возвращает сведения о типе объекта, которые можно использовать для получения сведений о типе интерфейса.Retrieves the type information for an object, which can be used to get the type information for an interface.

(Inherited from Attribute)
_Attribute.GetTypeInfoCount(UInt32)

Возвращает количество предоставляемых объектом интерфейсов для доступа к сведениям о типе (0 или 1).Retrieves the number of type information interfaces that an object provides (either 0 or 1).

(Inherited from Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

Предоставляет доступ к открытым свойствам и методам объекта.Provides access to properties and methods exposed by an object.

(Inherited from Attribute)

Applies to

See also