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

Статья
08/23/2023

Функция EcGetSubscriptionProperty извлекает определенное значение свойства из объекта подписки. Объект подписки задается дескриптором, переданным в параметр Subscription .

Синтаксис

BOOL EcGetSubscriptionProperty(
  [in]  EC_HANDLE                   Subscription,
  [in]  EC_SUBSCRIPTION_PROPERTY_ID PropertyId,
  [in]  DWORD                       Flags,
  [in]  DWORD                       PropertyValueBufferSize,
  [in]  PEC_VARIANT                 PropertyValueBuffer,
  [out] PDWORD                      PropertyValueBufferUsed
);

Параметры

[in] Subscription

Дескриптор объекта подписки.

[in] PropertyId

Идентификатор, указывающий, какое свойство подписки следует получить. Укажите значение из перечисления EC_SUBSCRIPTION_PROPERTY_ID . Если указать значение EcSubscriptionEventSources , будет возвращен дескриптор массива (EC_OBJECT_ARRAY_PROPERTY_HANDLE). Затем можно использовать функции EcGetObjectArrayProperty и EcSetObjectArrayProperty , чтобы получить и задать свойства Address, Enabled, UserName и Password в массиве.

[in] Flags

Зарезервировано. Должно иметь значение NULL.

[in] PropertyValueBufferSize

Размер предоставленного пользователем буфера для хранения значения свойства.

[in] PropertyValueBuffer

Предоставленный пользователем буфер для хранения значения свойства.

[out] PropertyValueBufferUsed

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

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

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

Требования

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

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

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

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