Fungsi TdhAggregatePayloadFilters (tdh.h)

Artikel
03/08/2023

Fungsi TdhAggregatePayloadFilters menggabungkan beberapa filter payload untuk satu penyedia ke dalam struktur data tunggal untuk digunakan dengan fungsi EnableTraceEx2 .

Sintaks

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

Parameter

PayloadFilterCount

Jumlah filter payload.

PayloadFilterPtrs

Array filter tunggal payload peristiwa, masing-masing dibuat oleh panggilan ke fungsi TdhCreatePayloadFilter .

[in, optional] EventMatchALLFlags

Array nilai Boolean yang sesuai dengan setiap filter payload yang diteruskan dalam parameter PayloadFilterPtrs dan menunjukkan bagaimana peristiwa ditangani ketika beberapa kondisi ditentukan.. Parameter ini hanya memengaruhi situasi di mana beberapa filter payload ditentukan untuk peristiwa yang sama.

Ketika nilai Boolean TRUE, peristiwa akan ditulis ke sesi jika salah satu kondisi yang ditentukan yang ditentukan dalam filter adalah TRUE. Jika bendera ini diatur ke TRUE pada satu atau beberapa filter untuk Id peristiwa atau versi peristiwa yang sama, maka peristiwa hanya ditulis jika semua filter yang ditandai untuk peristiwa terpenuhi.

Ketika nilai Boolean FALSE, peristiwa akan ditulis ke sesi hanya jika semua kondisi yang ditentukan yang ditentukan dalam filter adalah TRUE. Jika bendera ini diatur ke FALSE pada satu atau beberapa filter untuk Id peristiwa atau versi peristiwa yang sama, maka peristiwa ditulis jika salah satu filter yang tidak ditandai terpenuhi.

[out] EventFilterDescriptor

Penunjuk ke struktur EVENT_FILTER_DESCRIPTOR yang akan digunakan dengan fungsi EnableTraceEx2 . Struktur EVENT_FILTER_DESCRIPTOR akan berisi penunjuk ke filter payload agregat, yang telah dialokasikan oleh fungsi ini.

Ketika pemanggil selesai menggunakan struktur EVENT_FILTER_DESCRIPTOR ini dengan fungsi EnableTraceEx2 , fungsi TdhCleanupPayloadEventFilterDescriptor harus dipanggil untuk membebaskan memori yang dialokasikan.

Mengembalikan nilai

Mengembalikan ERROR_SUCCESS jika berhasil. Jika tidak, fungsi ini mengembalikan salah satu kode pengembalian berikut selain yang lain.

Menampilkan kode	Deskripsi
ERROR_INVALID_PARAMETER	Satu atau beberapa parameter tidak valid.
ERROR_NOT_ENOUGH_MEMORY	Tidak dapat mengalokasikan memori untuk membuat filter payload agregat.

Keterangan

Pada Windows 8.1,Windows Server 2012 R2, dan yang lebih baru, filter payload peristiwa dapat digunakan oleh fungsi EnableTraceEx2 untuk memfilter konten tertentu dari peristiwa dalam sesi pencatat.

Fungsi TdhAggregatePayloadFilters menggabungkan filter payload untuk satu penyedia ke dalam struktur data tunggal untuk digunakan dengan fungsi EnableTraceEx2 . TdhAggregatePayloadFilters mengalokasikan dan mengisi struktur data buram untuk filter payload agregat. Ketika filter payload agregat tidak lagi diperlukan, fungsi TdhCleanupPayloadEventFilterDescriptor digunakan untuk membebaskan memori yang dialokasikan untuk filter payload agregat dalam struktur EVENT_FILTER_DESCRIPTOR yang dikembalikan.

Contoh

Misalnya yang menggunakan fungsi TdhAggregatePayloadFilters untuk mengagregasi filter payload untuk digunakan dalam pemfilteran pada kondisi tertentu dalam sesi pencatat, lihat contoh untuk fungsi EnableTraceEx2 .

Persyaratan

Persyaratan	Nilai
Klien minimum yang didukung	Windows 8.1 [hanya aplikasi desktop]
Server minimum yang didukung	Windows Server 2012 R2 [hanya aplikasi desktop]
Target Platform	Windows
Header	tdh.h
Pustaka	Tdh.lib
DLL	Tdh.dll