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”,以指定所有訂閱物件的要求,或表示訂閱對象必須符合的一或多個條件的布爾表達式,才能包含在查詢結果中。 有效表示式的格式如下:
[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 專業版 [僅限傳統型應用程式] |
最低支援的伺服器 | Windows 2000 Server [僅限傳統型應用程式] |
目標平台 | Windows |
標頭 | eventsys.h |