evtOpenPublisherMetadata 函数 (winevt.h)
获取用于读取指定提供程序元数据的句柄。
语法
EVT_HANDLE EvtOpenPublisherMetadata(
[in, optional] EVT_HANDLE Session,
[in] LPCWSTR PublisherId,
[in, optional] LPCWSTR LogFilePath,
[in] LCID Locale,
[in] DWORD Flags
);
参数
[in, optional] Session
EvtOpenSession 函数返回的远程会话句柄。 设置为 NULL 可获取本地计算机上提供程序的元数据。
[in] PublisherId
提供程序的名称。 若要枚举计算机上注册的提供程序的名称,请调用 EvtOpenPublisherEnum 函数。
[in, optional] LogFilePath
包含提供程序记录的事件的存档日志文件的完整路径。 存档的日志文件还包含提供程序的元数据。 如果未在本地计算机上注册提供程序,请使用此参数。 从已注册的提供程序读取元数据时,设置为 NULL 。
[in] Locale
从提供程序访问本地化元数据时要使用的区域设置标识符。 若要创建区域设置标识符,请使用 MAKELCID 宏。 设置为 0 以使用调用线程的区域设置标识符。
[in] Flags
保留。 必须为零。
返回值
如果成功,该函数将返回提供程序元数据的句柄;否则为 NULL。 如果 为 NULL,则调用 GetLastError 函数以获取错误代码。
注解
如果指定存档日志文件,此函数将在日志文件中为指定提供程序的元数据检查。 如果在日志文件中找不到提供程序的元数据,则函数将在本地计算机上的已注册提供程序列表中搜索提供程序。
若要读取提供程序的元数据,请调用 EvtGetPublisherMetadataProperty 函数。 若要枚举提供程序定义的事件,请调用 EvtOpenEventMetadataEnum 函数。
完成后,必须调用 EvtClose 函数以关闭元数据句柄。
示例
有关演示如何使用此函数的示例,请参阅 获取提供程序的元数据。
要求
最低受支持的客户端 | Windows Vista [仅限桌面应用] |
最低受支持的服务器 | Windows Server 2008 [仅限桌面应用] |
目标平台 | Windows |
标头 | winevt.h |
Library | Wevtapi.lib |
DLL | Wevtapi.dll |