Win32 API 日本語リファレンス
ホーム › System.Com.Events › IMultiInterfaceEventControl

IMultiInterfaceEventControl

COM
📘 Microsoft Learn (日本語) · English
IID0343e2f5-86f6-11d1-b760-00c04fb926af継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

イベントをサブスクライバーに発行するオブジェクトであるイベントオブジェクトの動作を制御します。(IMultiInterfaceEventControl)

メソッド 7

vtbl = vtable インデックス(0始まり)。HSP等からCOMメソッドをインデックス指定で呼ぶ際に使用します。0〜2 は IUnknown。

vtbl 3 HRESULT SetMultiInterfacePublisherFilter(IMultiInterfacePublisherFilter* classFilter)

実行時にイベントメソッドにパブリッシャーフィルターを割り当てます。

classFilterIMultiInterfacePublisherFilter*in指定したメソッドに関連付けられたパブリッシャーフィルター上の IMultiInterfacePublisherFilter インターフェイスへのポインター。

戻り値

このメソッドは、標準の戻り値 E_INVALIDARG、E_OUTOFMEMORY、E_UNEXPECTED、E_FAIL に加えて、以下の値を返すことがあります。

リターン コード 説明
S_OK
 メソッドは正常に完了しました。
EVENT_E_INTERNALEXCEPTION
 予期しない例外が発生しました。
EVENT_E_INTERNALERROR
 予期しない内部エラーが検出されました。

解説(Remarks)

イベントパブリッシャーは、実行時にパブリッシャーフィルターをインストールすることで、フィルターに指定された条件を満たすサブスクライバーにのみイベントを発行できます。

vtbl 4 HRESULT GetSubscriptions(GUID* eventIID, LPWSTR bstrMethodName, LPWSTR optionalCriteria, INT* optionalErrorIndex, IEventObjectCollection** ppCollection)

イベントメソッドに関連付けられたサブスクリプションオブジェクトのコレクションを取得します。

eventIIDGUID*in発行元インターフェイスのインターフェイス識別子。
bstrMethodNameLPWSTRinサブスクリプションコレクションに関連付けられたイベントメソッド。
optionalCriteriaLPWSTRinクエリ条件を指定する文字列。このパラメーターが NULL の場合、SetDefaultQuery メソッドで指定された既定のクエリが使用されます。このパラメーターに有効な式を作成する方法の詳細については、後述の「解説」セクションを参照してください。
optionalErrorIndexINT*inoptionalCriteria パラメーター内のエラーの位置をオフセットで表したもの。このパラメーターに NULL を指定することはできません。
ppCollectionIEventObjectCollection**outイベントオブジェクトに関連付けられたサブスクリプションを列挙するコレクションオブジェクト上の IEventObjectCollection インターフェイスへのポインターのアドレス。

戻り値

このメソッドは、標準の戻り値 E_INVALIDARG、E_OUTOFMEMORY、E_UNEXPECTED、E_FAIL に加えて、以下の値を返すことがあります。

リターン コード 説明
S_OK
 メソッドは正常に完了しました。
EVENT_E_QUERYSYNTAX
 クエリ文字列を評価しようとしたときに構文エラーが発生しました。
EVENT_E_QUERYFIELD
 クエリ文字列で無効なフィールド名が使用されました。
EVENT_E_INTERNALEXCEPTION
 予期しない例外が発生しました。
EVENT_E_INTERNALERROR
 予期しない内部エラーが検出されました。

解説(Remarks)

このメソッドは、IEventSystem::Query メソッドをより特化させた形式です。サブスクリプションオブジェクトのみを取得するだけでなく、GetSubscriptions を呼び出して取得したコレクションは、サブスクリプションコレクションが変更されるたびに自動的に更新されます。

optionalCriteria パラメーターで指定するクエリ条件には、すべてのサブスクリプションオブジェクトを要求するための "ALL"、または、サブスクリプションオブジェクトがクエリ結果に含まれるために満たす必要がある 1 つ以上の条件を表すブール式を指定できます。有効な式は次の形式です。

[NOT] propertynamerelationalOperatorvalue。有効な関係演算子は次のとおりです。

==、=、!=、<>、~=。有効な値は "string"、'string'、{GUID}、TRUE、FALSE、NULL です。

個々のブール式は AND または OR で結合できます。式を括弧で入れ子にして、特定の評価順序を強制することもできます。

有効なクエリ条件の例を以下に示します。

"EventClassID == {F89859D1-6565-11D1-88C8-0080C7D771BF}"

"EventClassID == {F89859D1-6565-11D1-88C8-0080C7D771BF} AND MethodName = 'StockPriceChange'"

vtbl 5 HRESULT SetDefaultQuery(GUID* eventIID, LPWSTR bstrMethodName, LPWSTR bstrCriteria, INT* errorIndex)

パブリッシャーフィルターがイベントメソッドに関連付けられていない場合に使用される既定のクエリを設定します。

eventIIDGUID*in発行元インターフェイスのインターフェイス識別子。
bstrMethodNameLPWSTRin既定のクエリが割り当てられるメソッドの名前。
bstrCriteriaLPWSTRinクエリ条件を指定する文字列。このパラメーターに NULL を指定することはできません。このパラメーターに有効な式を作成する方法の詳細については、後述の「解説」セクションを参照してください。
errorIndexINT*outbstrCriteria パラメーター内のエラーの位置をオフセットで表したもの。

戻り値

このメソッドは、標準の戻り値 E_INVALIDARG、E_OUTOFMEMORY、E_UNEXPECTED、E_FAIL に加えて、以下の値を返すことがあります。

リターン コード 説明
S_OK
 メソッドは正常に完了しました。
EVENT_E_QUERYSYNTAX
 クエリ文字列を評価しようとしたときに構文エラーが発生しました。
EVENT_E_QUERYFIELD
 クエリ文字列で無効なフィールド名が使用されました。
EVENT_E_INTERNALEXCEPTION
 予期しない例外が発生しました。
EVENT_E_INTERNALERROR
 予期しない内部エラーが検出されました。

解説(Remarks)

このメソッドは、IEventSystem::Query メソッドをより特化させた形式です。サブスクリプションオブジェクトのみを取得するだけでなく、GetSubscriptions を呼び出して取得したコレクションは、サブスクリプションコレクションが変更されるたびに自動的に更新されます。

bstrCriteria パラメーターで指定するクエリ条件には、すべてのサブスクリプションオブジェクトを要求するための "ALL"、または、サブスクリプションオブジェクトがクエリ結果に含まれるために満たす必要がある 1 つ以上の条件を表すブール式を指定できます。有効な式は次の形式です。

[NOT] propertynamerelationalOperatorvalue。有効な関係演算子は次のとおりです。

==、=、!=、<>、~=。有効な値は "string"、'string'、{GUID}、TRUE、FALSE、NULL です。

個々のブール式は AND または OR で結合できます。式を括弧で入れ子にして、特定の評価順序を強制することもできます。

有効なクエリ条件の例を以下に示します。

"EventClassID == {F89859D1-6565-11D1-88C8-0080C7D771BF}"

"EventClassID == {F89859D1-6565-11D1-88C8-0080C7D771BF} AND MethodName = 'StockPriceChange'"

vtbl 6 HRESULT get_AllowInprocActivation(BOOL* pfAllowInprocActivation)

サブスクライバーをパブリッシャーのプロセス内でアクティブ化できるかどうかを示します。(IMultiInterfaceEventControl.get_AllowInprocActivation)

pfAllowInprocActivationBOOL*outインプロセスでのアクティブ化を許可するかどうかを受け取る。
vtbl 7 HRESULT put_AllowInprocActivation(BOOL fAllowInprocActivation)

サブスクライバーをパブリッシャーのプロセス内でアクティブ化できるかどうかを示します。(IMultiInterfaceEventControl.put_AllowInprocActivation)

fAllowInprocActivationBOOLinインプロセスでのアクティブ化を許可するかどうかを指定する。
vtbl 8 HRESULT get_FireInParallel(BOOL* pfFireInParallel)

イベントを2つ以上のサブスクライバーに並列で配信できるかどうかを示します。(Get)

pfFireInParallelBOOL*outサブスクライバーへのイベント発行を並列で行うかどうかを受け取る。
vtbl 9 HRESULT put_FireInParallel(BOOL fFireInParallel)

イベントを2つ以上のサブスクライバーに並列で配信できるかどうかを示します。(Put)

fFireInParallelBOOLinサブスクライバーへのイベント発行を並列で行うかどうかを指定する。
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

HSP用 COM定義

#usecom / #comfunc によるHSPのCOM呼び出し定義。数字は vtbl インデックス(0始まり)。クラスIDが無い場合 #usecom の末尾は "{}"、ある場合は "{CLSID}"。

出力引数: 
#define global IID_IMultiInterfaceEventControl "{0343E2F5-86F6-11D1-B760-00C04FB926AF}"
#usecom global IMultiInterfaceEventControl IID_IMultiInterfaceEventControl "{}"
#comfunc global IMultiInterfaceEventControl_SetMultiInterfacePublisherFilter  3 sptr
#comfunc global IMultiInterfaceEventControl_GetSubscriptions                  4 var,wstr,wstr,var,sptr
#comfunc global IMultiInterfaceEventControl_SetDefaultQuery                   5 var,wstr,wstr,var
#comfunc global IMultiInterfaceEventControl_get_AllowInprocActivation         6 var
#comfunc global IMultiInterfaceEventControl_put_AllowInprocActivation         7 int
#comfunc global IMultiInterfaceEventControl_get_FireInParallel                8 var
#comfunc global IMultiInterfaceEventControl_put_FireInParallel                9 int
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。