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

Статья
02/26/2024

Функция EcGetObjectArrayProperty извлекает значения свойств из дескриптора в массив свойств источника событий. Массив содержит значения свойств для источников событий подписки.

Синтаксис

BOOL EcGetObjectArrayProperty(
  [in]  EC_OBJECT_ARRAY_PROPERTY_HANDLE ObjectArray,
  [in]  EC_SUBSCRIPTION_PROPERTY_ID     PropertyId,
  [in]  DWORD                           ArrayIndex,
  [in]  DWORD                           Flags,
  [in]  DWORD                           PropertyValueBufferSize,
  [in]  PEC_VARIANT                     PropertyValueBuffer,
  [out] PDWORD                          PropertyValueBufferUsed
);

Параметры

[in] ObjectArray

Дескриптор массива свойств для источников событий для подписки. Дескриптор массива, возвращаемый методом EcGetSubscriptionProperty при передаче значения EcSubscriptionEventSources в параметр PropertyId .

[in] PropertyId

Идентификатор свойства для свойств в массиве. Укажите значение из перечисления EC_SUBSCRIPTION_PROPERTY_ID . Получите свойства Address, Enabled, UserName и Password в массиве, указав значения EcSubscriptionEventSourceAddress, EcSubscriptionEventSourceEnabled, EcSubscriptionEventSourceUserName или EcSubscriptionEventSourcePassword .

[in] ArrayIndex

Индекс массива, указывающий, из какого источника событий следует получить свойство.

[in] Flags

Зарезервировано. Должно быть равно 0.

[in] PropertyValueBufferSize

Размер буфера, содержащего значение свойства . Размер должен быть не ниже размера EC_VARIANT значения.

[in] PropertyValueBuffer

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

[out] PropertyValueBufferUsed

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

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

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

Невозможно получить свойство Password для источника событий или подписки. По соображениям безопасности возвращается пустая строка для значения свойства, а последняя ошибка будет иметь значение ERROR_ACCESS_DENIED.

Подписка может иметь несколько источников событий, и каждый источник может иметь свойства Address, Enabled, UserName и Password .

Примеры

Пример кода, использующий функцию EcGetObjectArrayProperty , см. в разделе Отображение свойств подписки сборщика событий.

Требования

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

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

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

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