Skip to content

Latest commit

 

History

History
145 lines (109 loc) · 3.19 KB

nf-tdh-tdhgetwppmessage.md

File metadata and controls

145 lines (109 loc) · 3.19 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:tdh.TdhGetWppMessage
TdhGetWppMessage function (tdh.h)
Retrieves the formatted WPP message embedded into an EVENT_RECORD structure.
TdhGetWppMessage
TdhGetWppMessage function [ETW]
etw.tdhgetwppmessage
tdh/TdhGetWppMessage
etw\tdhgetwppmessage.htm
ETW
e4daf7fb-4512-41bd-b7b9-3f9f1cd15037
12/05/2018
TdhGetWppMessage, TdhGetWppMessage function [ETW], etw.tdhgetwppmessage, tdh/TdhGetWppMessage
tdh.h
Windows
Windows 8 [desktop apps only]
Windows Server 2012 [desktop apps only]
Tdh.lib
Tdh.dll
Windows
19H1
TdhGetWppMessage
tdh/TdhGetWppMessage
c++
APIRef
kbSyntax
DllExport
Tdh.dll
Ext-MS-Win-Eventing-Tdh-Ext-L1-1-0.dll
TdhGetWppMessage

TdhGetWppMessage function

-description

Retrieves the formatted WPP message embedded into an EVENT_RECORD structure.

-parameters

-param Handle [in]

Type: TDH_HANDLE

A valid decoding handle.

-param EventRecord [in]

Type: PEVENT_RECORD

The event record passed to your EventRecordCallback callback.

-param BufferSize [in, out]

Type: PULONG

Size of the Buffer parameter, in bytes.

-param Buffer [out]

Type: PBYTE

User-allocated buffer that receives the property data.

-returns

Type: ULONG

Returns ERROR_SUCCESS if successful. Otherwise, this function returns one of the following return codes in addition to others.

Return code Description
ERROR_NOT_FOUND
The specified property was not found.
ERROR_INSUFFICIENT_BUFFER
BufferSize is too small. To get the required buffer size, call TdhGetPropertySize.
ERROR_INVALID_PARAMETER
One or more of the parameters is not valid.

-remarks

To retrieve a specific property instead of the decoded event message without specifying a property name, call TdhGetWppProperty.

-see-also

EVENT_RECORD

EventRecordCallback

TdhGetPropertySize

TdhGetWppProperty