COM 呼び出し可能ラッパー

[アーティクル]
05/09/2023

COM クライアントが .NET オブジェクトを呼び出すと、共通言語ランタイムがマネージドオブジェクトとそのオブジェクトのための COM 呼び出し可能ラッパー (CCW: COM Callable Wrapper) を作成します。 COM クライアントは .NET オブジェクトを直接参照できないため、CCW をマネージドオブジェクトのプロキシとして使用します。

ランタイムは、サービスを要求している COM クライアントの数に関係なく、1 つのマネージドオブジェクトに対して 1 つの CCW を作成します。次の図に示すように、複数の COM クライアントが、INew インターフェイスを公開する CCW への参照を保持できます。 CCW は、INew インターフェイスを実装するマネージドオブジェクトへの 1 つの参照を保持し、ガベージコレクションされます。 COM クライアントと .NET クライアントは、同一のマネージドオブジェジェクトに対して同時に要求できます。

Multiple COM clients holding a reference to the CCW that exposes INew.

COM 呼び出し可能ラッパーは、.NET ランタイム内で実行されている他のクラスからは見えません。 CCW の主な目的は、マネージドコードとアンマネージドコードの間の呼び出しをマーシャリングすることですが、CCW は、CCW にラップされているマネージドオブジェクトのオブジェクト ID やオブジェクトの有効期間の管理も行います。

オブジェクト ID

ランタイムは、ランタイムのガベージコレクションヒープから .NET オブジェクトにメモリを割り当てます。これにより、ランタイムは、メモリ内で必要に応じてオブジェクトを移動させることができます。一方、CCW に対して、ランタイムは、コレクションヒープ以外からメモリを割り当てます。これにより、COM クライアントはラッパーを直接参照できます。

オブジェクトの有効期間

CCW にラップされている .NET クライアントとは異なり、CCW は、従来の COM 方式で参照カウントを使用します。 CCW の参照カウントが 0 (ゼロ) に達すると、ラッパーはマネージドオブジェクトの参照を解放します。参照が残っていないマネージドオブジェクトは、次のガベージコレクションサイクルで収集されます。

COM インターフェイスのシミュレート

CCW は、パブリックで COM から参照できるすべてのインターフェイス、データ型、および戻り値を、COM によるインターフェイスベースの対話の適用と整合性のある方法で COM クライアントに公開します。 COM クライアントの場合、.NET オブジェクトのメソッドを呼び出すことは、COM オブジェクトのメソッドを呼び出すことと同じです。

このシームレスなアプローチを実現するために、CCW は IUnknown や IDispatch などの従来の COM インターフェイスを製造します。次の図が示すように、CCW は、ラップしている .NET オブジェクトの 1 つの参照を保持します。 COM クライアントと .NET オブジェクトの両方は、CCW のプロキシとスタブ構築を介して相互に対話します。

Diagram that shows how CCW manufactures COM interfaces.

マネージド環境でクラスによって明示的に実装されるインターフェイスを公開するだけでなく、.NET ランタイムは、オブジェクトの代わりに、次の表に一覧表示されている COM インターフェイスの実装を提供します。 .NET クラスは、これらのインターフェイスの独自の実装を提供することで、既定の動作をオーバーライドできます。ただし、ランタイムは IUnknown と IDispatch インターフェイス実装を常に提供します。

Interface	説明
IDispatch	型への遅延バインディングのメカニズムを提供します。
IErrorInfo	エラー、そのソース、ヘルプファイル、ヘルプコンテキスト、およびエラーを定義したインターフェイスの GUID (.NET クラスでは常に GUID_NULL) に関する説明文を示します。
IProvideClassInfo	マネージドクラスによって実装される ITypeInfo インターフェイスに COM クライアントがアクセスできるようにします。 COM からインポートされていない型については、.NET Core 上で `COR_E_NOTSUPPORTED` を返します。
ISupportErrorInfo	マネージドオブジェクトが IErrorInfo インターフェイスをサポートするかどうかを COM クライアントが判別できるようにします。その場合は、クライアントが最新の例外オブジェクトへのポインターを取得できるようにします。すべてのマネージド型は、IErrorInfo インターフェイスをサポートします。
ITypeInfo (.NET Framework のみ)	Tlbexp.exe によって生成された型情報と完全に等しい、クラスの型情報を提供します。
IUnknown	COM クライアントが CCW の有効期間を管理し、強制型変換を提供するための、IUnknown インターフェイスの標準的な実装を提供します。

マネージドクラスは、次の表で説明されている COM インターフェイスを提供することもできます。

Interface	説明
(_classname) クラスインターフェイス	マネージドオブジェクトで明示的に公開されている、すべてのパブリックインターフェイス、メソッド、プロパティ、およびフィールドを公開する、ランタイムによって公開され、明示的に定義されていない、インターフェイス、
IConnectionPoint と IConnectionPointContainer	デリゲートベースのソースイベント (イベントサブスクライバーを登録するためのインターフェイス) を供給するオブジェクトのインターフェイス。
IDispatchEx (.NET Framework のみ)	クラスが IExpando を実装する場合、ランタイムによって提供されているインターフェイス。 IDispatchEx インターフェイスは、IDispatch インターフェイスの拡張版で、IDispatch とは異なり、列挙、追加、削除、および大文字小文字を区別したメンバーの呼び出しが可能になります。
IEnumVARIANT	クラスが IEnumerable を実装する場合、コレクション内のオブジェクトを列挙するコレクション型クラスのインターフェイス。

クラスインターフェイスの概要

マネージドコードで明示的に定義されていないクラスインターフェイスは、.NET オブジェクトで明示的に公開されるすべてのパブリックメソッド、プロパティ、フィールド、およびイベントを公開するインターフェイスです。このインターフェイスは、デュアルまたはディスパッチ専用インターフェイスです。クラスインターフェイスは、前にアンダースコアの付いた、.NET クラス自体の名前を受け取ります。たとえば、クラス Mammal の場合、クラスインターフェイスは _Mammal です。

派生クラスの場合、クラスインターフェイスは、基本クラスのすべてのパブリックメソッド、プロパティ、およびフィールドも公開します。派生クラスは、各基本クラスのクラスインターフェイスも公開します。たとえば、クラス Mammal がクラス MammalSuperclass を拡張し、そのクラスがさらに System.Object を拡張する場合、.NET オブジェクトは COM クライアントに _Mammal、_MammalSuperclass、および _Object という名前の 3 つのクラスインターフェイスを公開します。

たとえば、次の .NET クラスを考えます。

' Applies the ClassInterfaceAttribute to set the interface to dual.
<ClassInterface(ClassInterfaceType.AutoDual)> _
' Implicitly extends System.Object.
Public Class Mammal
    Sub Eat()
    Sub Breathe()
    Sub Sleep()
End Class

// Applies the ClassInterfaceAttribute to set the interface to dual.
[ClassInterface(ClassInterfaceType.AutoDual)]
// Implicitly extends System.Object.
public class Mammal
{
    public void Eat() {}
    public void Breathe() {}
    public void Sleep() {}
}

COM クライアントは、_Mammal という名前のクラスインターフェイスへのポインターを取得できます。 .NET Framework では、タイプライブラリエクスポーター (Tlbexp.exe) ツールを使用して、_Mammalインターフェイス定義を含むタイプライブラリを生成できます。タイプライブラリエクスポーターは、.NET Core ではサポートされません。 Mammal クラスが 1 つ以上のインターフェイスを実装した場合、それらのインターフェイスはコクラスの下に表示されます。

[odl, uuid(…), hidden, dual, nonextensible, oleautomation]
interface _Mammal : IDispatch
{
    [id(0x00000000), propget] HRESULT ToString([out, retval] BSTR*
        pRetVal);
    [id(0x60020001)] HRESULT Equals([in] VARIANT obj, [out, retval]
        VARIANT_BOOL* pRetVal);
    [id(0x60020002)] HRESULT GetHashCode([out, retval] short* pRetVal);
    [id(0x60020003)] HRESULT GetType([out, retval] _Type** pRetVal);
    [id(0x6002000d)] HRESULT Eat();
    [id(0x6002000e)] HRESULT Breathe();
    [id(0x6002000f)] HRESULT Sleep();
}
[uuid(…)]
coclass Mammal
{
    [default] interface _Mammal;
}

クラスインターフェイスの生成はオプションです。既定では、COM 相互運用が、タイプライブラリにエクスポートするクラスごとにディスパッチ専用インターフェイスを生成します。 ClassInterfaceAttribute をクラスに適用することによって、このインターフェイスの自動作成を防止または変更することができます。クラスインターフェイスにより、マネージドクラスを COM に公開するタスクを軽減できますが、その使用は制限されています。

注意事項

独自のものを明示的に定義する代わりにクラスインターフェイスを使用すると、マネージドクラスの将来のバージョン管理が複雑になることがあります。クラスインターフェイスを使用する前に、次のガイドラインを参照してください。

クラスインターフェイスを生成するのではなく、COM クライアントが使用する明示的なインターフェイスを定義します。

COM 相互運用はクラスインターフェイスを自動的に生成するため、クラスにバージョン後の変更が生じると、共通言語ランタイムによって公開されているクラスインターフェイスのレイアウトが変更されることがあります。 COM クライアントは通常、インターフェイスのレイアウトの変更を処理するように準備されていないため、クラスのメンバーレイアウトを変更した場合に、クライアントが破損します。

このガイドラインは、COM クライアントに公開されるインターフェイスは変更不可にしておく必要があるという概念を促進しています。間違えてインターフェイスのレイアウトを並べ替えることで COM クライアントが破損するリスクを抑えるため、インターフェイスを明示的に定義して、クラスに対するすべての変更をインターフェイスレイアウトから分離します。

ClassInterfaceAttribute を使用してクラスインターフェイスの自動生成を中止し、次のコードフラグメントに示すように、クラスの明示的なインターフェイスを実装します。

<ClassInterface(ClassInterfaceType.None)>Public Class LoanApp
    Implements IExplicit
    Sub M() Implements IExplicit.M
…
End Class

[ClassInterface(ClassInterfaceType.None)]
public class LoanApp : IExplicit
{
    int IExplicit.M() { return 0; }
}

ClassInterfaceType.None 値により、クラスメタデータをタイプライブラリにエクスポートするときに、クラスインターフェイスが生成されなくなります。前の例では、COM クライアントは IExplicit インターフェイスを通してのみ LoanApp クラスにアクセスできます。

ディスパッチ識別子 (DISPID) をキャッシュしないようにします。

クラスインターフェイスの使用は、インターフェイスメンバーの DISPID をキャッシュしていないスクリプト化されたクライアント、Microsoft Visual Basic 6.0 クライアント、または遅延バインディングクライアントのために許容されるオプションです。 DISPID は遅延バインディングを有効にするインターフェイスメンバーを特定します。

クラスインターフェイスでは、インターフェイス内のメンバーの位置に基づいて DISPID が生成されます。メンバーの順序を変更してクラスをタイプライブラリにエクスポートすると、クラスインターフェイスで生成される DISPID が変更されます。

クラスインターフェイスを使用するとき、遅延バインドされた COM クライアントの中断を回避するには、ClassInterfaceAttribute に ClassInterfaceType.AutoDispatch 値を指定して適用します。この値は、ディスパッチ専用のクラスのインターフェイスを実装しますが、タイプライブラリからインターフェイスの説明を省略します。インターフェイスの説明がないと、クライアントはコンパイル時に DISPID をキャッシュできません。これはクラスインターフェイスの既定のインターフェイス型ですが、属性値を明示的に適用することもできます。

<ClassInterface(ClassInterfaceType.AutoDispatch)> Public Class LoanApp
    Implements IAnother
    Sub M() Implements IAnother.M
…
End Class

[ClassInterface(ClassInterfaceType.AutoDispatch)]
public class LoanApp
{
    public int M() { return 0; }
}

実行時にインターフェイスメンバーの DISPID を取得するために、COM クライアントは IDispatch.GetIdsOfNames を呼び出すことができます。インターフェイスでメソッドを呼び出すには、返された DISPID を IDispatch.Invoke への引数として渡します。

クラスインターフェイス用のデュアルインターフェイスのオプションの使用を制限します。

デュアルインターフェイスは、COM クライアントによるインターフェイスメンバーへの事前バインディングと遅延バインディングを有効にします。デザイン時およびテスト中は、クラスインターフェイスをデュアルに設定すると役に立つ場合があります。変更されることのないマネージドクラス (およびその基本クラス) の場合、このオプションも使用できます。それ以外の場合はすべて、クラスインターフェイスをデュアルに設定しないでください。

自動的に生成されたデュアルインターフェイスが適切な場合もまれにありますが、より多くの場合、それはバージョンに関連する複雑さを生じさせます。たとえば、派生クラスのクラスインターフェイスを使用する COM クライアントは、基本クラスが変更されると簡単に中断します。サードパーティが基本クラスを提供するとき、クラスインターフェイスのレイアウトを自分で制御することはできません。さらに、ディスパッチ専用インターフェイスとは異なり、デュアルインターフェイス (ClassInterfaceType.AutoDual) は、エクスポートされたタイプライブラリ内にクラスインターフェイスの説明を提供します。そのような説明により、遅延バインディングのクライアントではコンパイル時に DISPID をキャッシュすることが促進されます。

すべての COM イベント通知が遅延バインドされていることを確認します。

既定では、COM の型情報はマネージドアセンブリに直接埋め込まれているため、プライマリ相互運用アセンブリ (PIA) の必要はありません。ただし、埋め込まれた型情報の制限の 1 つとして、早期にバインドされた vtable 呼び出しによる COM イベント通知の配信はサポートされず、遅延バインドされた IDispatch::Invoke 呼び出しのみがサポートされるということがあります。

アプリケーションから COM イベントインターフェイスメソッドに対して早期にバインドされた呼び出しが必要な場合は、Visual Studio の [相互運用型の埋め込み] プロパティを true に設定するか、プロジェクトファイルに次の要素を含めることができます。

<EmbedInteropTypes>True</EmbedInteropTypes>

COM 呼び出し可能ラッパー

オブジェクト ID

オブジェクトの有効期間

COM インターフェイスのシミュレート

クラスインターフェイスの概要

クラスインターフェイスを生成するのではなく、COM クライアントが使用する明示的なインターフェイスを定義します。

ディスパッチ識別子 (DISPID) をキャッシュしないようにします。

クラスインターフェイス用のデュアルインターフェイスのオプションの使用を制限します。

すべての COM イベント通知が遅延バインドされていることを確認します。

関連項目

フィードバック

その他のリソース

COM 呼び出し可能ラッパー

オブジェクト ID

オブジェクトの有効期間

COM インターフェイスのシミュレート

クラス インターフェイスの概要

クラス インターフェイスを生成するのではなく、COM クライアントが使用する明示的なインターフェイスを定義します。

ディスパッチ識別子 (DISPID) をキャッシュしないようにします。

クラス インターフェイス用のデュアル インターフェイスのオプションの使用を制限します。

すべての COM イベント通知が遅延バインドされていることを確認します。

関連項目

フィードバック

その他のリソース

クラスインターフェイスの概要

クラスインターフェイスを生成するのではなく、COM クライアントが使用する明示的なインターフェイスを定義します。

クラスインターフェイス用のデュアルインターフェイスのオプションの使用を制限します。