EcGetSubscriptionRunTimeStatus 函数 (evcoll.h)

  • 项目

EcGetSubscriptionRunTimeStatus 函数检索订阅的事件源或订阅本身的运行时状态信息。 订阅由其名称指定。 如果事件源为 NULL，则会检索整个订阅的状态。

语法

BOOL EcGetSubscriptionRunTimeStatus(
  [in]  LPCWSTR                                SubscriptionName,
  [in]  EC_SUBSCRIPTION_RUNTIME_STATUS_INFO_ID StatusInfoId,
  [in]  LPCWSTR                                EventSourceName,
  [in]  DWORD                                  Flags,
  [in]  DWORD                                  StatusValueBufferSize,
  [in]  PEC_VARIANT                            StatusValueBuffer,
  [out] PDWORD                                 StatusValueBufferUsed
);

参数

[in] SubscriptionName

要从中获取运行时状态信息的订阅的名称。

[in] StatusInfoId

指定要从订阅获取的运行时状态信息的标识符。 指定 EC_SUBSCRIPTION_RUNTIME_STATUS_INFO_ID 枚举中的值。 EcSubscriptionRunTimeStatusEventSources 值可用于获取与订阅关联的事件源的列表。

[in] EventSourceName

要从中获取状态的事件源的名称。 每个订阅可以有多个事件源。

[in] Flags

保留。 必须为 NULL。

[in] StatusValueBufferSize

将保存运行时状态信息的用户提供的缓冲区的大小。

[in] StatusValueBuffer

用户提供的用于保存运行时状态信息的缓冲区。 缓冲区将保留适当的值，具体取决于传递到 StatusInfoId 参数中的EC_SUBSCRIPTION_RUNTIME_STATUS_INFO_ID值。

[out] StatusValueBufferUsed

成功返回时函数使用的用户提供的缓冲区的大小，或函数因 ERROR_INSUFFICIENT_BUFFER失败而存储属性值所需的大小。

返回值

此函数返回 BOOL。

要求

   
最低受支持的客户端 Windows Vista
最低受支持的服务器 Windows Server 2008
目标平台 Windows
标头 evcoll.h
Library Wecapi.lib
DLL Wecapi.dll

请参阅

Windows 事件收集器函数