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

[アーティクル]
08/09/2011

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

派生クラスの場合、クラスインターフェイスは、基本クラスのすべてのパブリックメソッド、プロパティ、およびフィールドも公開します。派生クラスも、各基本クラスに対して、クラスインターフェイスを公開します。たとえば、クラス Mammal が、クラス MammalSuperclass を拡張し、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
{
    void  Eat();
    void  Breathe():
    void  Sleep();
}

COM クライアントは、タイプライブラリに記述されている _Mammal というクラスインターフェイスへのポインターを取得できます。タイプライブラリは、タイプライブラリエクスポーター (Tlbexp.exe) ツールによって生成されます。クラス 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 相互運用機能により、タイプライブラリにエクスポートされるクラスごとに 1 つのディスパッチ専用インターフェイスが生成されます。クラスに ClassInterfaceAttribute を適用することにより、このクラスインターフェイスを自動生成しないようにするか、または自動生成の方法を変更できます。クラスインターフェイスによって、COM へのマネージクラス公開の作業は簡単になりますが、その使用には制限があります。

注意
独自に明示的に定義する代わりに、クラスインターフェイスを使用した場合、将来のマネージクラスのバージョン管理が複雑になる可能性があります。クラスインターフェイスを使用する前に、次のガイドラインを一読してください。

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 {
    void M();
}

ClassInterfaceType.None 値は、クラスのメタデータがタイプライブラリにエクスポートされるときに、クラスインターフェイスが生成されないようにします。上の例では、COM クライアントは、IExplicit インターフェイスを使用した場合にだけ、LoanApp クラスにアクセスできます。

ディスパッチ ID (DispId) をキャッシュしないでください。

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

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

クラスインターフェイスを使用するときは、遅延バインディングされる COM クライアントが機能しなくなるのを防ぐために、ClassInterfaceType.AutoDispatch 値の ClassInterfaceAttribute を適用してください。この値は、ディスパッチ専用クラスインターフェイスを実装しますが、タイプライブラリからのインターフェイス記述は省略します。インターフェイス記述がないと、クライアントはコンパイル時に DispId をキャッシュできません。ディスパッチ専用クラスインターフェイスはクラスインターフェイスの既定のインターフェイス型ですが、明示的に ClassInterfaceType.AutoDispatch 属性値を適用できます。

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

[ClassInterface(ClassInterfaceType.AutoDispatch]
public class LoanApp : IAnother {
    void M();
}

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

クラスインターフェイスに対して、デュアルインターフェイスオプションを使用しないでください。

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

自動的に生成されるデュアルインターフェイスの使用が適切なのはまれであり、ほとんどの場合、バージョン管理が複雑になります。たとえば、派生クラスのクラスインターフェイスを使用する COM のクライアントは、基本クラスの変更によって簡単に機能しなくなる可能性があります。サードパーティの基本クラスを使用したときは、クラスインターフェイスのレイアウトは制御できません。また、ディスパッチ専用インターフェイスとは異なり、デュアルインターフェイス (ClassInterface.AutoDual) は、エクスポートされたタイプライブラリ内にクラスインターフェイスの記述を提供します。このような記述は、遅延バインディングされるクライアントが実行時に DispId をキャッシュする結果になります。

参照

ClassInterfaceAttribute

概念

COM 呼び出し可能ラッパー

相互運用のための .NET 型の要件

次の方法で共有

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

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

ディスパッチ ID (DispId) をキャッシュしないでください。

クラスインターフェイスに対して、デュアルインターフェイスオプションを使用しないでください。

参照

参照

概念

その他のリソース

次の方法で共有

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

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

ディスパッチ ID (DispId) をキャッシュしないでください。

クラス インターフェイスに対して、デュアル インターフェイス オプションを使用しないでください。

参照

参照

概念

その他のリソース

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

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

クラスインターフェイスに対して、デュアルインターフェイスオプションを使用しないでください。