Função TdhCleanupPayloadEventFilterDescriptor (tdh.h)

Artigo
03/05/2024

A função TdhCleanupPayloadEventFilterDescriptor libera a estrutura agregada de filtros de conteúdo criados usando a função TdhAggregatePayloadFilters .

Sintaxe

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

Parâmetros

[in, out] EventFilterDescriptor

Um ponteiro para uma estrutura EVENT_FILTER_DESCRIPTOR que contém filtros agregados em que a memória alocada deve ser liberada. A estrutura de EVENT_FILTER_DESCRIPTOR passada foi criada chamando a função TdhAggregatePayloadFilters .

Se a chamada for bem-sucedida, a memória alocada será liberada para os filtros agregados e os campos na estrutura de EVENT_FILTER_DESCRIPTOR retornada serão inicializados novamente

Retornar valor

Retorna ERROR_SUCCESS se tiver êxito. Caso contrário, essa função retornará um dos seguintes códigos de retorno, além de outros.

Código de retorno	Descrição
ERROR_INVALID_PARAMETER	Um ou mais dos parâmetros não são válidos.

Comentários

Em Windows 8.1, Windows Server 2012 R2 e posterior, os filtros de conteúdo de evento podem ser usados pela função EnableTraceEx2 para filtrar o conteúdo específico do evento em uma sessão de agente.

A função TdhCleanupPayloadEventFilterDescriptor é usada para liberar memória alocada retornada pela função TdhAggregatePayloadFilters .

Exemplos

Para obter um exemplo que usa a função TdhCleanupPayloadEventFilterDescriptor para liberar a memória usada por filtros de conteúdo agregados, consulte o exemplo da função EnableTraceEx2 .

Requisitos

Requisito	Valor
Cliente mínimo com suporte	Windows 8.1 [somente aplicativos da área de trabalho]
Servidor mínimo com suporte	Windows Server 2012 R2 [somente aplicativos da área de trabalho]
Plataforma de Destino	Windows
Cabeçalho	tdh.h
Biblioteca	Tdh.lib
DLL	Tdh.dll