TdhCleanupPayloadEventFilterDescriptor, fonction (tdh.h)

Article
03/02/2024

La fonction TdhCleanupPayloadEventFilterDescriptor libère la structure agrégée des filtres de charge utile créés à l’aide de la fonction TdhAggregatePayloadFilters .

Syntaxe

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

Paramètres

[in, out] EventFilterDescriptor

Pointeur vers une structure EVENT_FILTER_DESCRIPTOR qui contient des filtres agrégés dans lesquels la mémoire allouée doit être libérée. La structure EVENT_FILTER_DESCRIPTOR passée a été créée en appelant la fonction TdhAggregatePayloadFilters .

Si l’appel réussit, la mémoire allouée est libérée pour les filtres agrégés et les champs de la structure EVENT_FILTER_DESCRIPTOR retournée sont réinitialisés

Valeur retournée

Retourne ERROR_SUCCESS en cas de réussite. Sinon, cette fonction retourne l’un des codes de retour suivants en plus d’autres.

Code de retour	Description
ERROR_INVALID_PARAMETER	Un ou plusieurs paramètres ne sont pas valides.

Remarques

Sur Windows 8.1,Windows Server 2012 R2 et versions ultérieures, la fonction EnableTraceEx2 peut utiliser des filtres de charge utile d’événement pour filtrer le contenu spécifique de l’événement dans une session d’enregistreur d’événements.

La fonction TdhCleanupPayloadEventFilterDescriptor est utilisée pour libérer la mémoire allouée qui est retournée par la fonction TdhAggregatePayloadFilters .

Exemples

Pour obtenir un exemple qui utilise la fonction TdhCleanupPayloadEventFilterDescriptor pour libérer de la mémoire utilisée par les filtres de charge utile d’agrégation, consultez l’exemple de la fonction EnableTraceEx2 .

Configuration requise

Condition requise	Valeur
Client minimal pris en charge	Windows 8.1 [applications de bureau uniquement]
Serveur minimal pris en charge	Windows Server 2012 R2 [applications de bureau uniquement]
Plateforme cible	Windows
En-tête	tdh.h
Bibliothèque	Tdh.lib
DLL	Tdh.dll