TdhGetEventInformation 函数 (tdh.h)
检索有关事件的元数据。
语法
TDHSTATUS TdhGetEventInformation(
[in] PEVENT_RECORD Event,
[in] ULONG TdhContextCount,
[in] PTDH_CONTEXT TdhContext,
[out] PTRACE_EVENT_INFO Buffer,
[in, out] PULONG BufferSize
);
参数
[in] Event
传递给 EventRecordCallback 回调的事件记录。 有关详细信息,请参阅 EVENT_RECORD 结构。
[in] TdhContextCount
pTdhContext 中的元素数。
[in] TdhContext
仅适用于 WPP 或经典 ETW 事件的上下文值数组;否则为 NULL。 有关详细信息,请参阅 TDH_CONTEXT 结构。 数组不得包含重复的上下文类型。
[out] Buffer
用户分配的缓冲区,用于接收事件信息。 有关详细信息,请参阅 TRACE_EVENT_INFO 结构。
[in, out] BufferSize
pBuffer 缓冲区的大小(以字节为单位)。 如果函数成功,此参数将接收所用缓冲区的大小。 如果缓冲区太小,函数将返回ERROR_INSUFFICIENT_BUFFER并将此参数设置为所需的缓冲区大小。 如果输入时缓冲区大小为零,则缓冲区中不返回任何数据,并且此参数接收所需的缓冲区大小。
返回值
如果成功,则返回ERROR_SUCCESS。 否则,此函数除了返回其他返回代码外,还会返回以下返回代码之一。
返回代码 | 说明 |
---|---|
|
pBuffer 缓冲区的大小太小。 使用 pBufferSize 中设置的所需缓冲区大小来分配新缓冲区。 |
|
找不到事件的架构。 |
|
一个或多个参数无效。 |
|
清单中的 resourceFileName 属性包含提供程序二进制文件的位置。 注册清单时,该位置将写入注册表。 TDH 无法根据注册的位置找到二进制文件。 |
|
WMI 服务不可用。 |
注解
如果事件是 WPP 或旧版 ETW 事件,则可以指定用于帮助分析事件信息的上下文信息。 如果在 EVENT_HEADER 的 Flags 成员中设置了EVENT_HEADER_FLAG_TRACE_MESSAGE标志,则事件是 WPP 事件, (看到 EVENT_RECORD) 的 EventHeader 成员。 如果设置了EVENT_HEADER_FLAG_CLASSIC_HEADER标志,则事件是旧版 ETW 事件。
示例
有关演示如何检索有关事件的元数据的示例,请参阅 使用 TdhFormatProperty 来使用事件数据。
要求
要求 | 值 |
---|---|
最低受支持的客户端 | Windows Vista [仅限桌面应用] |
最低受支持的服务器 | Windows Server 2008 [仅限桌面应用] |
目标平台 | Windows |
标头 | tdh.h |
Library | Tdh.lib |
DLL | Tdh.dll |