Функция EcGetSubscriptionRunTimeStatus (evcoll.h)

Статья
08/23/2023

Функция 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

Предоставленный пользователем буфер, который будет содержать сведения о состоянии времени выполнения. Буфер будет содержать соответствующее значение в зависимости от EC_SUBSCRIPTION_RUNTIME_STATUS_INFO_ID значения, переданного в параметр StatusInfoId .

[out] StatusValueBufferUsed

Размер предоставленного пользователем буфера, используемого функцией при успешном возвращении, или размер, необходимый для хранения значения свойства при сбое функции с ERROR_INSUFFICIENT_BUFFER.

Возвращаемое значение

Эта функция возвращает BOOL.

Требования


Минимальная версия клиента	Windows Vista
Минимальная версия сервера	Windows Server 2008
Целевая платформа	Windows
Header	evcoll.h
Библиотека	Wecapi.lib
DLL	Wecapi.dll

См. также раздел

Функции сборщика событий Windows

Поделиться через