IConnectionPointContainer
COM公式ドキュメント
接続可能オブジェクトの接続ポイントをサポートします。(IConnectionPointContainer)
解説(Remarks)
接続可能オブジェクトは、次の機能をサポートします。
- イベントセットなどのアウトゴーイングインターフェイス
- アウトゴーイングインターフェイスの IID を列挙する機能
- それらのアウトゴーイング IID について、シンクをオブジェクトに接続および切断する機能
- 特定のアウトゴーイングインターフェイスに存在する接続を列挙する機能
メソッド 2
vtbl = vtable インデックス(0始まり)。HSP等からCOMメソッドをインデックス指定で呼ぶ際に使用します。0〜2 は IUnknown。
接続可能オブジェクトがサポートするすべての接続ポイントを、アウトゴーイング IID ごとに 1 つずつ反復処理するための列挙子オブジェクトを作成します。
| ppEnum | IEnumConnectionPoints** | out | 新しく作成された列挙子へのポインターを受け取る IEnumConnectionPoints インターフェイスポインター変数へのポインター。 |
戻り値
このメソッドは、標準の戻り値 E_OUTOFMEMORY および E_UNEXPECTED に加えて、次の値を返すことがあります。
| 戻りコード | 説明 |
|---|---|
| 列挙子オブジェクトが正常に作成されました。 | |
| ppEnum のアドレスが有効ではありません。たとえば、NULL である可能性があります。 |
解説(Remarks)
IEnumConnectionPoints は IConnectionPoint へのポインターを列挙するため、呼び出し元は IConnectionPoint::GetConnectionInterface を使用して、その接続ポイントがサポートするアウトゴーイングインターフェイスのインターフェイス識別子を判別する必要があります。
呼び出し元への注意
呼び出し元は、列挙子が不要になったときに Release を呼び出す責任があります。実装者への注意
E_NOTIMPL を返すことは明示的に禁止されています。型情報を除いて、呼び出し元がアウトゴーイングインターフェイスの IID を見つける他の手段がなくなるためです。接続可能オブジェクトは通常、既知のアウトゴーイングインターフェイスの固定セットを持つため、コンパイル時に判明している IID の固定長配列の上に列挙子を実装するのは簡単です。指定した IID がサポートされているアウトゴーイングインターフェイスを表す場合に、その IID に対応する接続ポイントの IConnectionPoint インターフェイスへのポインターを返します。
| riid | GUID* | in | 接続ポイントオブジェクトが要求されているアウトゴーイングインターフェイスのインターフェイス識別子。 |
| ppCP | IConnectionPoint** | out | riid インターフェイスをサポートする接続ポイントへのポインターを受け取る IConnectionPoint インターフェイスポインター変数のアドレス。エラーが発生した場合、実装はこの値を NULL に設定します。 |
戻り値
このメソッドは、標準の戻り値 E_OUTOFMEMORY および E_UNEXPECTED に加えて、次の値を返すことがあります。
| 戻りコード | 説明 |
|---|---|
| メソッドが正常に完了しました。 | |
| ppCP のアドレスが有効ではありません。たとえば、NULL である可能性があります。 | |
| この接続可能オブジェクトは、riid で指定されたアウトゴーイングインターフェイスをサポートしていません。 |
解説(Remarks)
このメソッドは、オブジェクトのアウトゴーイングインターフェイスに対する QueryInterface に相当します。ここでアウトゴーイングインターフェイスは riid で指定され、返されるインターフェイスポインターは常に接続ポイントのものです。
呼び出し元への注意
呼び出しが成功した場合、呼び出し元は接続ポイントが不要になったときに Release を呼び出して接続ポイントを解放する責任があります。実装者への注意
このメソッドの戻り値として E_NOTIMPL は許可されません。IConnectionPointContainer のすべての実装は、接続可能オブジェクトのアウトゴーイングインターフェイスに対してこのメソッドを実装する必要があります。Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
HSP用 COM定義
#usecom / #comfunc によるHSPのCOM呼び出し定義。数字は vtbl インデックス(0始まり)。クラスIDが無い場合 #usecom の末尾は "{}"、ある場合は "{CLSID}"。
#define global IID_IConnectionPointContainer "{B196B284-BAB4-101A-B69C-00AA00341D07}" #usecom global IConnectionPointContainer IID_IConnectionPointContainer "{}" #comfunc global IConnectionPointContainer_EnumConnectionPoints 3 sptr #comfunc global IConnectionPointContainer_FindConnectionPoint 4 var,sptr ; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。 ; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。 ; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。 ; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。#define global IID_IConnectionPointContainer "{B196B284-BAB4-101A-B69C-00AA00341D07}" #usecom global IConnectionPointContainer IID_IConnectionPointContainer "{}" #comfunc global IConnectionPointContainer_EnumConnectionPoints 3 sptr #comfunc global IConnectionPointContainer_FindConnectionPoint 4 sptr,sptr ; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。 ; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。 ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。 ; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。