Funzione TdhAggregatePayloadFilters (tdh.h)

Articolo
03/08/2023

La funzione TdhAggregatePayloadFilters aggrega più filtri payload per un singolo provider in una singola struttura di dati da usare con la funzione EnableTraceEx2 .

Sintassi

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

Parametri

PayloadFilterCount

Numero di filtri del payload.

PayloadFilterPtrs

Matrice di filtri singoli del payload dell'evento, ognuno creato da una chiamata alla funzione TdhCreatePayloadFilter .

[in, optional] EventMatchALLFlags

Matrice di valori booleani che corrispondono a ogni filtro del payload passato nel parametro PayloadFilterPtrs e indica come vengono gestiti gli eventi quando vengono specificate più condizioni. Questo parametro influisce solo sulle situazioni in cui vengono specificati più filtri payload per lo stesso evento.

Quando un valore booleano è TRUE, un evento verrà scritto in una sessione se una delle condizioni specificate nel filtro è TRUE. Se questo flag è impostato su TRUE su uno o più filtri per la stessa versione dell'ID evento o dell'evento, l'evento viene scritto solo se vengono soddisfatti tutti i filtri contrassegnati per l'evento.

Quando un valore booleano è FALSE, un evento verrà scritto in una sessione solo se tutte le condizioni specificate specificate nel filtro sono TRUE. Se questo flag è impostato su FALSE in uno o più filtri per la stessa versione dell'ID evento o dell'evento, l'evento viene scritto se uno dei filtri non contrassegnati viene soddisfatto.

[out] EventFilterDescriptor

Puntatore a una struttura EVENT_FILTER_DESCRIPTOR da usare con la funzione EnableTraceEx2 . La struttura EVENT_FILTER_DESCRIPTOR conterrà un puntatore ai filtri del payload aggregati, allocati da questa funzione.

Al termine dell'uso di questa struttura di EVENT_FILTER_DESCRIPTOR con la funzione EnableTraceEx2 , la funzione TdhCleanupPayloadEventFilterDescriptor deve essere chiamata per liberare la memoria allocata.

Valore restituito

Restituisce ERROR_SUCCESS se riuscito. In caso contrario, questa funzione restituisce uno dei codici restituiti seguenti oltre ad altri.

Codice restituito	Descrizione
ERROR_INVALID_PARAMETER	Uno o più parametri non sono validi.
ERROR_NOT_ENOUGH_MEMORY	Impossibile allocare memoria per creare il filtro payload aggregato.

Commenti

In Windows 8.1,Windows Server 2012 R2 e versioni successive, i filtri del payload degli eventi possono essere usati dalla funzione EnableTraceEx2 per filtrare il contenuto specifico dell'evento in una sessione del logger.

La funzione TdhAggregatePayloadFilters aggrega i filtri payload per un singolo provider in una singola struttura di dati da usare con la funzione EnableTraceEx2 . TdhAggregatePayloadFilters alloca e riempie una struttura di dati opaca per un filtro payload aggregato. Quando il filtro payload aggregato non è più necessario, la funzione TdhCleanupPayloadEventFilterDescriptor viene usata per liberare memoria allocata per il filtro payload aggregato nella struttura EVENT_FILTER_DESCRIPTOR restituita.

Esempio

Per un esempio che usa la funzione TdhAggregatePayloadFilters per aggregare i filtri del payload da usare in condizioni specifiche in una sessione di logger, vedere l'esempio per la funzione EnableTraceEx2 .

Requisiti

Requisito	Valore
Client minimo supportato	Windows 8.1 [solo app desktop]
Server minimo supportato	Windows Server 2012 R2 [solo app desktop]
Piattaforma di destinazione	Windows
Intestazione	tdh.h
Libreria	Tdh.lib
DLL	Tdh.dll