Función TdhAggregatePayloadFilters (tdh.h)

La función TdhAggregatePayloadFilters agrega varios filtros de carga para un único proveedor en una única estructura de datos para su uso con la función EnableTraceEx2 .

Sintaxis

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

Parámetros

PayloadFilterCount

Recuento de filtros de carga.

PayloadFilterPtrs

Matriz de filtros únicos de carga de eventos, cada uno creado por una llamada a la función TdhCreatePayloadFilter .

[in, optional] EventMatchALLFlags

Matriz de valores booleanos que corresponden a cada filtro de carga pasado en el parámetro PayloadFilterPtrs e indica cómo se controlan los eventos cuando se especifican varias condiciones. Este parámetro solo afecta a situaciones en las que se especifican varios filtros de carga para el mismo evento.

Cuando un valor booleano es TRUE, un evento se escribirá en una sesión si alguna de las condiciones especificadas en el filtro es TRUE. Si esta marca se establece en TRUE en uno o varios filtros para el mismo identificador de evento o versión de evento, el evento solo se escribe si se cumplen todos los filtros marcados para el evento.

Cuando un valor booleano es FALSE, un evento se escribirá en una sesión solo si todas las condiciones especificadas en el filtro son TRUE. Si esta marca se establece en FALSE en uno o varios filtros para el mismo identificador de evento o versión de evento, el evento se escribe si se cumple alguno de los filtros no marcados.

[out] EventFilterDescriptor

Puntero a una estructura de EVENT_FILTER_DESCRIPTOR que se va a usar con la función EnableTraceEx2 . La estructura EVENT_FILTER_DESCRIPTOR contendrá un puntero a los filtros de carga agregados, que esta función ha asignado.

Cuando el autor de la llamada termine de usar esta estructura de EVENT_FILTER_DESCRIPTOR con la función EnableTraceEx2 , se debe llamar a la función TdhCleanupPayloadEventFilterDescriptor para liberar la memoria asignada.

Valor devuelto

Devuelve ERROR_SUCCESS si se ejecuta correctamente. De lo contrario, esta función devuelve uno de los siguientes códigos de retorno además de otros.

Código devuelto Descripción
ERROR_INVALID_PARAMETER
Uno o varios de los parámetros no son válidos.
ERROR_NOT_ENOUGH_MEMORY
No se puede asignar memoria para crear el filtro de carga agregado.

Comentarios

En Windows 8.1,Windows Server 2012 R2 y versiones posteriores, la función EnableTraceEx2 puede usar filtros de carga de eventos para filtrar por el contenido específico del evento en una sesión del registrador.

La función TdhAggregatePayloadFilters agrega filtros de carga para un único proveedor en una única estructura de datos para su uso con la función EnableTraceEx2 . TdhAggregatePayloadFilters asigna y rellena una estructura de datos opaca para un filtro de carga agregado. Cuando el filtro de carga agregado ya no es necesario, la función TdhCleanupPayloadEventFilterDescriptor se usa para liberar memoria asignada para el filtro de carga agregado en la estructura de EVENT_FILTER_DESCRIPTOR devuelta.

Ejemplos

Para obtener un ejemplo que usa la función TdhAggregatePayloadFilters para agregar filtros de carga para usarlos en el filtrado de condiciones específicas en una sesión de registrador, vea el ejemplo de la función EnableTraceEx2 .

Requisitos

Requisito Value
Cliente mínimo compatible Windows 8.1 [solo aplicaciones de escritorio]
Servidor mínimo compatible Windows Server 2012 R2 [solo aplicaciones de escritorio]
Plataforma de destino Windows
Encabezado tdh.h
Library Tdh.lib
Archivo DLL Tdh.dll

Consulte también

ENABLE_TRACE_PARAMETERS

EVENT_FILTER_DESCRIPTOR

EnableTraceEx2

TdhCleanupPayloadEventFilterDescriptor

TdhCreatePayloadFilter

TdhDeletePayloadFilter