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

Функция EvtGetObjectArrayProperty (winevt.h)

  • Статья

Возвращает свойство метаданных поставщика из указанного объекта в массиве.

Синтаксис

BOOL EvtGetObjectArrayProperty(
  [in]  EVT_OBJECT_ARRAY_PROPERTY_HANDLE ObjectArray,
  [in]  DWORD                            PropertyId,
  [in]  DWORD                            ArrayIndex,
  [in]  DWORD                            Flags,
  [in]  DWORD                            PropertyValueBufferSize,
  [in]  PEVT_VARIANT                     PropertyValueBuffer,
  [out] PDWORD                           PropertyValueBufferUsed
);

Параметры

[in] ObjectArray

Дескриптор массива объектов, возвращаемых функцией EvtGetPublisherMetadataProperty .

[in] PropertyId

Идентификатор свойства метаданных, которое требуется получить из указанного объекта. Возможные значения см. в разделе Примечания EVT_PUBLISHER_METADATA_PROPERTY_ID.

[in] ArrayIndex

Отсчитываемый от нуля индекс объекта в массиве.

[in] Flags

Зарезервировано. Должен равняться нулю.

[in] PropertyValueBufferSize

Размер буфера PropertyValueBuffer в байтах.

[in] PropertyValueBuffer

Буфер, выделенный вызывающим объектом, который получит свойство метаданных. Буфер содержит объект EVT_VARIANT . Для этого параметра можно задать значение NULL , чтобы определить требуемый размер буфера.

[out] PropertyValueBufferUsed

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

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

Возвращаемый код/значение Описание
TRUE
 Функция выполнена успешно.
FALSE
 Сбой функции. Чтобы получить код ошибки, вызовите функцию GetLastError .

Комментарии

При вызове функции EvtGetPublisherMetadataProperty со следующими идентификаторами функция возвращает дескриптор массиву объектов этого типа:

  • EvtPublisherMetadataChannelReferences
  • EvtPublisherMetadataLevels
  • EvtPublisherMetadataTasks
  • EvtPublisherMetadataOpcodes
  • EvtPublisherMetadataKeywords
Например, если передать EvtPublisherMetadataKeywords в EvtGetPublisherMetadataProperty, функция возвращает дескриптор массиву объектов ключевое слово.

Чтобы определить размер массива, вызовите функцию EvtGetObjectArraySize .

Примеры

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

Требования

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

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

EVT_PUBLISHER_METADATA_PROPERTY_ID

EvtGetPublisherMetadataProperty