IEventSystem::Remove メソッド (eventsys.h)

  • [アーティクル]

イベント データ ストアから 1 つ以上のサブスクリプションまたはイベント オブジェクトを削除します。

構文

HRESULT Remove(
  [in]  BSTR progID,
  [in]  BSTR queryCriteria,
  [out] int  *errorIndex
);

パラメーター

[in] progID

削除するオブジェクト クラスの ProgID。 有効なイベント オブジェクト クラス識別子である必要があります。 このパラメーターには、次のいずれかの値を指定できます。

  • PROGID_EventClass
  • PROGID_EventClassCollection
  • PROGID_EventSubscription
  • PROGID_EventSubscriptionCollection

[in] queryCriteria

クエリ条件。 このパラメーターの有効な式の形成の詳細については、以下の「備考」セクションを参照してください。

[out] errorIndex

queryCriteria パラメーターのエラーの位置をオフセットとして表します。

戻り値

このメソッドは、E_INVALIDARG、E_OUTOFMEMORY、E_UNEXPECTED、E_FAILの標準戻り値と、次の値を返すことができます。

リターン コード 説明
S_OK
 メソッドは正常に完了しました。
EVENT_E_QUERYSYNTAX
 クエリ文字列の評価中に構文エラーが発生しました。
EVENT_E_QUERYFIELD
 クエリ文字列で無効なフィールド名が使用されました。
EVENT_E_NOT_ALL_REMOVED
 要求されたすべてのオブジェクトを削除できるわけではありません。

解説

queryCriteria パラメーターで指定されるクエリ条件は、"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'"

要件

   
サポートされている最小のクライアント Windows 2000 Professional [デスクトップ アプリのみ]
サポートされている最小のサーバー Windows 2000 Server [デスクトップ アプリのみ]
対象プラットフォーム Windows
ヘッダー eventsys.h

関連項目

IEventSystem