EvtGetPublisherMetadataProperty 函数 (winevt.h)
获取指定的提供程序元数据属性。
语法
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,则为所需的缓冲区大小。
返回值
返回代码/值 | 说明 |
---|---|
|
函数成功。 |
|
函数失败。 若要获取错误代码,请调用 GetLastError 函数。 |
注解
EvtGetEventMetadataProperty 可以在 EventMetadataPropertyBuffer 变量中返回许多不同类型的值。 如果 EventMetadataPropertyBuffer-Type> == EvtVarTypeEvtHandle,则 EventMetadataPropertyBuffer 包含需要释放的句柄。 完成句柄后,调用 EvtClose 函数。
示例
有关演示如何使用此函数的示例,请参阅 获取提供程序的元数据。
要求
要求 | 值 |
---|---|
最低受支持的客户端 | Windows Vista [仅限桌面应用] |
最低受支持的服务器 | Windows Server 2008 [仅限桌面应用] |
目标平台 | Windows |
标头 | winevt.h |
Library | Wevtapi.lib |
DLL | Wevtapi.dll |