TdhAggregatePayloadFilters 関数 (tdh.h)
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 を返します。 それ以外の場合、この関数は、他のリターン コードに加えて、次のいずれかのリターン コードを返します。
| リターン コード | 説明 |
|---|---|
|
1 つ以上のパラメーターが無効です。 |
|
集計されたペイロード フィルターを作成するためにメモリを割り当てることができません。 |
注釈
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 |