IEventControl::GetSubscriptions メソッド (eventsys.h)

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

構文

HRESULT GetSubscriptions(
  [in]          BSTR                   methodName,
  [in]          BSTR                   optionalCriteria,
  [in]          int                    *optionalErrorIndex,
  [out, retval] IEventObjectCollection **ppCollection
);

パラメーター

[in] methodName

サブスクリプション コレクションに関連付けられているイベント メソッド。

[in] optionalCriteria

クエリ条件。 このパラメーターが NULL の場合、 SetDefaultQuery メソッドで指定された既定のクエリが使用されます。 このパラメーターの有効な式の形成の詳細については、以下の「備考」セクションを参照してください。

[in] optionalErrorIndex

OptionalCriteria パラメーターのエラーの位置をオフセットとして表します。 このパラメーターを NULL にすることはできません。

[out, retval] ppCollection

イベント オブジェクトに関連付けられているサブスクリプションを列挙するコレクション オブジェクトの IEventObjectCollection インターフェイスへのポインターのアドレス。

戻り値

このメソッドは、成功すると S_OK を返します。 そうでない場合は、HRESULT エラー コードを返します。

注釈

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

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

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

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

個々のブール式は、AND または OR と結合できます。 式をかっこで入れ子にして、特定の評価順序を適用できます。

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

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

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

要件

こちらもご覧ください

IEventControl