TdhAggregatePayloadFilters 関数 (tdh.h)

[アーティクル]
03/08/2023

TdhAggregatePayloadFilters 関数は、1 つのプロバイダーの複数のペイロードフィルターを、EnableTraceEx2 関数で使用するために 1 つのデータ構造に集計します。

構文

TDHSTATUS TdhAggregatePayloadFilters(
                 ULONG                    PayloadFilterCount,
                 PVOID                    *PayloadFilterPtrs,
  [in, optional] PBOOLEAN                 EventMatchALLFlags,
  [out]          PEVENT_FILTER_DESCRIPTOR EventFilterDescriptor
);

パラメーター

PayloadFilterCount

ペイロードフィルターの数。

PayloadFilterPtrs

イベントペイロードの 1 つのフィルターの配列。それぞれ TdhCreatePayloadFilter 関数の呼び出しによって作成されます。

[in, optional] EventMatchALLFlags

PayloadFilterPtrs パラメーターで渡される各ペイロードフィルターに対応し、複数の条件が指定されている場合のイベントの処理方法を示すブール値の配列。このパラメーターは、同じイベントに対して複数のペイロードフィルターが指定されている状況にのみ影響します。

ブール値が TRUE の場合、フィルターで指定された条件のいずれかが TRUE の場合、イベントがセッションに書き込まれます。同じイベント ID またはイベントバージョンの 1 つ以上のフィルターでこのフラグが TRUE に設定されている場合、イベントのフラグが設定されたすべてのフィルターが満たされた場合にのみ、イベントが書き込まれます。

ブール値が FALSE の場合、フィルターで指定されたすべての条件が TRUE の場合にのみ、イベントがセッションに書き込まれます。同じイベント ID またはイベントバージョンの 1 つ以上のフィルターでこのフラグが FALSE に設定されている場合、フラグが設定されていないフィルターのいずれかが満たされると、イベントが書き込まれます。

[out] EventFilterDescriptor

EnableTraceEx2 関数で使用するEVENT_FILTER_DESCRIPTOR構造体へのポインター。 EVENT_FILTER_DESCRIPTOR構造体には、この関数によって割り当てられた集計ペイロードフィルターへのポインターが含まれます。

呼び出し元が EnableTraceEx2 関数でこのEVENT_FILTER_DESCRIPTOR構造体を使用し終わったら、割り当てられたメモリを解放するために TdhCleanupPayloadEventFilterDescriptor 関数を呼び出す必要があります。

戻り値

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

リターンコード	説明
ERROR_INVALID_PARAMETER	1 つ以上のパラメーターが無効です。
ERROR_NOT_ENOUGH_MEMORY	集計されたペイロードフィルターを作成するためにメモリを割り当てることができません。

注釈

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

TdhAggregatePayloadFilters 関数は、EnableTraceEx2 関数で使用するために、1 つのプロバイダーのペイロードフィルターを 1 つのデータ構造に集計します。 TdhAggregatePayloadFilters は、集計されたペイロードフィルターの不透明なデータ構造を割り当てて入力します。集計されたペイロードフィルターが不要になると、 TdhCleanupPayloadEventFilterDescriptor 関数を使用して、返される EVENT_FILTER_DESCRIPTOR 構造体の集計ペイロードフィルターに割り当てられたメモリを解放します。

例

TdhAggregatePayloadFilters 関数を使用して、ロガーセッションの特定の条件に対するフィルター処理で使用するペイロードフィルターを集計する例については、EnableTraceEx2 関数の例を参照してください。

要件

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