Função TdhAggregatePayloadFilters (tdh.h)

Artigo
03/02/2024

A função TdhAggregatePayloadFilters agrega vários filtros de carga para um único provedor em uma única estrutura de dados para uso com a função EnableTraceEx2 .

Sintaxe

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

Parâmetros

PayloadFilterCount

A contagem de filtros de carga.

PayloadFilterPtrs

Uma matriz de filtros únicos de conteúdo de evento, cada um criado por uma chamada para a função TdhCreatePayloadFilter .

[in, optional] EventMatchALLFlags

Uma matriz de valores boolianos que correspondem a cada filtro de carga passado no parâmetro PayloadFilterPtrs e indica como os eventos são tratados quando várias condições são especificadas.. Esse parâmetro afeta apenas situações em que vários filtros de carga estão sendo especificados para o mesmo evento.

Quando um valor booliano for TRUE, um evento será gravado em uma sessão se qualquer uma das condições especificadas especificadas no filtro for TRUE. Se esse sinalizador estiver definido como TRUE em um ou mais filtros para a mesma ID de evento ou versão de evento, o evento só será gravado se todos os filtros sinalizados para o evento forem atendidos.

Quando um valor booliano for FALSE, um evento será gravado em uma sessão somente se todas as condições especificadas especificadas no filtro forem TRUE. Se esse sinalizador for definido como FALSE em um ou mais filtros para a mesma ID de evento ou versão de evento, o evento será gravado se algum dos filtros não sinalizados for atendido.

[out] EventFilterDescriptor

Um ponteiro para uma estrutura EVENT_FILTER_DESCRIPTOR a ser usada com a função EnableTraceEx2 . A estrutura EVENT_FILTER_DESCRIPTOR conterá um ponteiro para os filtros de conteúdo agregados, que foram alocados por essa função.

Quando o chamador terminar de usar essa estrutura EVENT_FILTER_DESCRIPTOR com a função EnableTraceEx2 , a função TdhCleanupPayloadEventFilterDescriptor deverá ser chamada para liberar a memória alocada.

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.
ERROR_NOT_ENOUGH_MEMORY	Não é possível alocar memória para criar o filtro de conteúdo agregado.

Comentários

Em Windows 8.1,Windows Server 2012 R2 e posteriores, 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 TdhAggregatePayloadFilters agrega filtros de carga para um único provedor em uma única estrutura de dados para uso com a função EnableTraceEx2 . O TdhAggregatePayloadFilters aloca e preenche uma estrutura de dados opaca para um filtro de carga agregado. Quando o filtro de conteúdo agregado não é mais necessário, a função TdhCleanupPayloadEventFilterDescriptor é usada para liberar memória alocada para o filtro de carga agregado na estrutura EVENT_FILTER_DESCRIPTOR retornada.

Exemplos

Para obter um exemplo que usa a função TdhAggregatePayloadFilters para agregar filtros de carga a serem usados na filtragem em condições específicas em uma sessão de agente, 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