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

Статья
08/27/2023

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

Синтаксис

BOOL EvtGetPublisherMetadataProperty(
  [in]  EVT_HANDLE                         PublisherMetadata,
  [in]  EVT_PUBLISHER_METADATA_PROPERTY_ID PropertyId,
  [in]  DWORD                              Flags,
  [in]  DWORD                              PublisherMetadataPropertyBufferSize,
  [in]  PEVT_VARIANT                       PublisherMetadataPropertyBuffer,
  [out] PDWORD                             PublisherMetadataPropertyBufferUsed
);

Параметры

[in] PublisherMetadata

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

[in] PropertyId

Идентификатор извлекаемого свойства метаданных. Список идентификаторов свойств см. в перечислении EVT_PUBLISHER_METADATA_PROPERTY_ID .

[in] Flags

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

[in] PublisherMetadataPropertyBufferSize

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

[in] PublisherMetadataPropertyBuffer

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

[out] PublisherMetadataPropertyBufferUsed

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

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

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

EvtGetEventMetadataProperty может возвращать множество различных типов значений в переменной EventMetadataPropertyBuffer . Если EventMetadataPropertyBuffer-Type> == EvtVarTypeEvtHandle, то EventMetadataPropertyBuffer содержит дескриптор, который необходимо освободить. Завершив работу с дескриптором, вызовите функцию EvtClose .

Примеры

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

Требования

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

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

EvtOpenPublisherMetadata

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