TdhCleanupPayloadEventFilterDescriptor 関数 (tdh.h)

TdhCleanupPayloadEventFilterDescriptor 関数は、TdhAggregatePayloadFilters 関数を使用して作成されたペイロードフィルターの集計構造を解放します。

構文

TDHSTATUS TdhCleanupPayloadEventFilterDescriptor(
  [in, out] PEVENT_FILTER_DESCRIPTOR EventFilterDescriptor
);

[in, out] EventFilterDescriptor

割り当てられたメモリを解放する集計フィルターを含む EVENT_FILTER_DESCRIPTOR 構造体へのポインター。渡された EVENT_FILTER_DESCRIPTOR 構造体は、TdhAggregatePayloadFilters 関数を呼び出すことによって作成されました。

呼び出しが成功すると、集計フィルターに割り当てられたメモリが解放され、返された EVENT_FILTER_DESCRIPTOR 構造体内のフィールドが再初期化されます

成功した場合 はERROR_SUCCESS を返します。それ以外の場合、この関数は、他のリターンコードに加えて、次のいずれかのリターンコードを返します。

リターンコード	説明
ERROR_INVALID_PARAMETER	1 つ以上のパラメーターが無効です。

Windows 8.1、Windows Server 2012 R2 以降では、EnableTraceEx2 関数でイベントペイロードフィルターを使用して、ロガーセッション内のイベントの特定のコンテンツをフィルター処理できます。

TdhCleanupPayloadEventFilterDescriptor 関数は、TdhAggregatePayloadFilters 関数によって返される割り当てられたメモリを解放するために使用されます。

集計ペイロードフィルターで使用されるメモリを解放するために TdhCleanupPayloadEventFilterDescriptor 関数を使用する例については、 EnableTraceEx2 関数の例を参照してください。

要件	値
サポートされている最小のクライアント	Windows 8.1 [デスクトップアプリのみ]
サポートされている最小のサーバー	Windows Server 2012 R2 [デスクトップアプリのみ]
対象プラットフォーム	Windows
ヘッダー	tdh.h
Library	Tdh.lib
[DLL]	Tdh.dll