TdhDeletePayloadFilter function
The TdhDeletePayloadFilter function frees the memory allocated for a single payload filter by the TdhCreatePayloadFilter function.
Syntax
ULONG TDHAPI TdhDeletePayloadFilter( _Inout_ PVOID *PayloadFilterDescriptor );
Parameters
- PayloadFilterDescriptor [in, out]
-
A pointer to a single payload filter allocated by the TdhCreatePayloadFilter function.
Return value
Returns ERROR_SUCCESS if successful. Otherwise, this function returns one of the following return codes in addition to others.
| Return code | Description |
|---|---|
|
One or more of the parameters is not valid. |
Remarks
On Windows 8.1,Windows Server 2012 R2, and later, event payload filters can be used by the EnableTraceEx2 function to filter on the specific content of the event in a logger session.
The TdhDeletePayloadFilter function is used to free memory allocated for a single payload filter that is returned by the TdhCreatePayloadFilter function.
Requirements
|
Minimum supported client |
Windows 8.1 [desktop apps only] |
|---|---|
|
Minimum supported server |
Windows Server 2012 R2 [desktop apps only] |
|
Header |
|
|
Library |
|
|
DLL |
|
See also
- EnableTraceEx2
- ENABLE_TRACE_PARAMETERS
- EVENT_FILTER_DESCRIPTOR
- TdhAggregatePayloadFilters
- TdhCleanupPayloadEventFilterDescriptor
- TdhCreatePayloadFilter