PreserveSigAttribute クラス

.NET Framework クラス ライブラリ リファレンス

PreserveSigAttribute クラス

COM 相互運用呼び出し中に発生する HRESULT または retval シグネチャ変換を中止することを示します。

名前空間: System.Runtime.InteropServices
アセンブリ: mscorlib (mscorlib.dll 内)
構文

Visual Basic (宣言)

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

Visual Basic (使用法)

Dim instance As PreserveSigAttribute

C#

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

C++

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

J#

/** @attribute ComVisibleAttribute(true) */ 
/** @attribute AttributeUsageAttribute(AttributeTargets.Method, Inherited=false)
 */ 
public final class PreserveSigAttribute extends
 Attribute

JScript

ComVisibleAttribute(true) 
AttributeUsageAttribute(AttributeTargets.Method, Inherited=false)
 
public final class PreserveSigAttribute extends
 Attribute

解説

この属性は、メソッドに適用できます。

既定では、タイプ ライブラリ エクスポータ (Tlbexp.exe) によって、HRESULT に S_OK を返す呼び出しは、[out, retval] パラメータが関数の戻り値として使用されるように、変換されます。S_OK の HRESULT は破棄されます。HRESULT が S_OK 以外の場合、共通言語ランタイムは例外をスローして、[out, retval] パラメータを破棄します。PreserveSigAttribute をマネージ メソッドのシグネチャに適用した場合、属性が適用されたメソッドのマネージ シグネチャとアンマネージ シグネチャは同一になります。

メンバが複数の成功 HRESULT 値を返し、またその複数の値を検出する必要がある場合は、元のメソッドのシグネチャの保持が必要となります。ほとんどの COM メンバは HRESULT を 1 つ返すため、PreserveSigAttribute を適用することによって、成功またはエラーの HRESULT を表す整数値を取得できます。Tlbexp.exe はすべての [out, retval] パラメータをマネージ シグネチャに out パラメータとして保持します。

タイプ ライブラリ インポータ (Tlbimp.exe) もこの属性を適用します。Tlbimp.exe は、タイプ ライブラリをインポートするときにこの属性をディスパッチ インターフェイスに適用します。

メモ
COM からマネージ コードへの相互運用時に、マネージ コードが PreserveSigAttribute クラスでマークされていた場合、PreserveSigAttribute クラスでは、戻り値の Currency、Guid、および Object の型はサポートされません。これらの条件で、これらのいずれかの戻り値の型を PreserveSigAttribute クラスで使用すると、TypeLoadException がスローされます。

使用例

アセンブリを COM タイプ ライブラリにエクスポートするときに、Tlbexp.exe が PreserveSigAttribute なしで C# メソッドを変換する場合の例を次に示します。

マネージ シグネチャ :

int DoSomething (long l);

アンマネージ シグネチャ :

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

PreserveSigAttribute を同じ C# メソッドに適用して、アセンブリをエクスポートした場合、メソッドの変換は前の例とは異なります。Tlbexp.exe は HRESULT および [out, retval] パラメータ修飾子を削除することに注目してください。

マネージ シグネチャ :

[PreserveSig] int DoSomething (long l);

アンマネージ シグネチャ :

int DoSomething ([in] long l);

継承階層

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

スレッド セーフ

この型の public static (Visual Basic では Shared) メンバはすべて、スレッド セーフです。インスタンス メンバの場合は、スレッド セーフであるとは限りません。

プラットフォーム

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

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0、1.1、1.0
.NET Compact Framework
サポート対象 : 2.0

参照

関連項目
PreserveSigAttribute メンバ
System.Runtime.InteropServices 名前空間
その他の技術情報
タイプ ライブラリ エクスポータ (Tlbexp.exe)
タイプ ライブラリ インポータ (Tlbimp.exe)