TdhGetWppProperty 函数 (tdh.h)

  • 项目

检索与 WPP 消息关联的特定属性。

语法

TDHSTATUS TdhGetWppProperty(
  [in]      TDH_HANDLE    Handle,
  [in]      PEVENT_RECORD EventRecord,
  [in]      PWSTR         PropertyName,
  [in, out] PULONG        BufferSize,
  [out]     PBYTE         Buffer
);

参数

[in] Handle

类型： TDH_HANDLE

有效的解码句柄。

[in] EventRecord

类型： PEVENT_RECORD

传递给 EventRecordCallback 回调的事件记录。

[in] PropertyName

类型： PWSTR

要检索的属性的名称。

有关可能值的列表，请参阅 PROPERTY_DATA_DESCRIPTOR。

[in, out] BufferSize

类型： PULONG

Buffer 参数的大小（以字节为单位）。

[out] Buffer

类型： PBYTE

接收属性数据的用户分配的缓冲区。

返回值

类型： ULONG

如果成功，则返回ERROR_SUCCESS。 否则，此函数除了返回其他返回代码外，还会返回以下返回代码之一。

返回代码 说明
ERROR_NOT_FOUND
 未找到指定的属性。
ERROR_INSUFFICIENT_BUFFER
 BufferSize 太小。 若要获取所需的缓冲区大小，请调用 TdhGetWppProperty 两次，一次使用 null 缓冲区和指针来检索缓冲区大小，再调用大小正确的缓冲区。
ERROR_INVALID_PARAMETER
 一个或多个参数不正确。 如果 Handle、 EventRecord、 PropertyName 或 Buffer 参数为 NULL，则返回此错误。

注解

若要在不指定属性名称的情况下仅检索已解码的事件消息，请调用 TdhGetWppMessage。

要求

要求 值
最低受支持的客户端 Windows 8 [仅限桌面应用]
最低受支持的服务器 Windows Server 2012 [仅限桌面应用]
目标平台 Windows
标头 tdh.h
Library Tdh.lib
DLL Tdh.dll

另请参阅

EVENT_RECORD

EventRecordCallback

TdhGetPropertySize

TdhGetWppMessage