TdhCleanupPayloadEventFilterDescriptor function

The TdhCleanupPayloadEventFilterDescriptor function frees the aggregated structure of payload filters created using the TdhAggregatePayloadFilters function.

Syntax

TDHSTATUS TdhCleanupPayloadEventFilterDescriptor(
  PEVENT_FILTER_DESCRIPTOR EventFilterDescriptor
);

Parameters

EventFilterDescriptor

A pointer to an EVENT_FILTER_DESCRIPTOR structure that contains aggregated filters where the allocated memory is to be freed. The EVENT_FILTER_DESCRIPTOR structure passed was created by calling the TdhAggregatePayloadFilters function.

If the call is successful, allocated memory is released for the aggregated filters and the fields in the returned EVENT_FILTER_DESCRIPTOR structure are re-initialized

Return Value

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

Return code Description
ERROR_INVALID_PARAMETER
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 specific content of the event in a logger session.

The TdhCleanupPayloadEventFilterDescriptor function is used to free memory allocated that is returned by the TdhAggregatePayloadFilters function.

Examples

For an example that uses the TdhCleanupPayloadEventFilterDescriptor function to free memory used by aggregate payload filters, see the example for the EnableTraceEx2 function.

Requirements

   
Minimum supported client Windows 8.1 [desktop apps only]
Minimum supported server Windows Server 2012 R2 [desktop apps only]
Target Platform Windows
Header tdh.h
Library Tdh.lib
DLL Tdh.dll

See Also

ENABLE_TRACE_PARAMETERS

EVENT_FILTER_DESCRIPTOR

EnableTraceEx2

TdhAggregatePayloadFilters

TdhCreatePayloadFilter

TdhDeletePayloadFilter