IMultiInterfaceEventControl::GetSubscriptions 方法 (eventsys.h)
检索与事件方法关联的订阅对象的集合。
语法
HRESULT GetSubscriptions(
[in] REFIID eventIID,
[in] BSTR bstrMethodName,
[in] BSTR optionalCriteria,
[in] int *optionalErrorIndex,
[out, retval] IEventObjectCollection **ppCollection
);
参数
[in] eventIID
触发接口的接口标识符。
[in] bstrMethodName
与订阅集合关联的事件方法。
[in] optionalCriteria
指定查询条件的字符串。 如果此参数为 NULL,则使用 SetDefaultQuery 方法指定的默认查询。 有关为此参数构成有效表达式的详细信息,请参阅下面的“备注”部分。
[in] optionalErrorIndex
以偏移量表示的 optionalCriteria 参数中错误的位置。 此参数不能为 NULL。
[out, retval] ppCollection
指向集合对象上 IEventObjectCollection 接口的指针的地址,该集合对象枚举与事件对象关联的订阅。
返回值
此方法可以返回标准返回值E_INVALIDARG、E_OUTOFMEMORY、E_UNEXPECTED和E_FAIL,以及以下值。
返回代码 | 说明 |
---|---|
|
该方法已成功完成。 |
|
尝试计算查询字符串时出现语法错误。 |
|
在查询字符串中使用了无效的字段名称。 |
|
引发意外异常。 |
|
检测到意外的内部错误。 |
备注
此方法是 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 Professional [仅限桌面应用] |
最低受支持的服务器 | Windows 2000 Server [仅限桌面应用] |
目标平台 | Windows |
标头 | eventsys.h |