ホーム › System.Diagnostics.Etw › TdhAggregatePayloadFilters

TdhAggregatePayloadFilters

関数

複数のペイロードフィルターを集約しフィルター記述子を生成する。

DLLTDH.dll呼出規約winapi対応OSWindows 8.1 以降

シグネチャ

// TDH.dll
#include <windows.h>

DWORD TdhAggregatePayloadFilters(
    DWORD PayloadFilterCount,
    void** PayloadFilterPtrs,
    BOOLEAN* EventMatchALLFlags,   // optional
    EVENT_FILTER_DESCRIPTOR* EventFilterDescriptor
);

パラメーター

名前	型	方向	説明
PayloadFilterCount	DWORD	in	ペイロードフィルターの数。
PayloadFilterPtrs	void**	in	イベントペイロードの単一フィルターの配列。各フィルターは TdhCreatePayloadFilter 関数の呼び出しによって作成されます。
EventMatchALLFlags	BOOLEAN*	inoptional	PayloadFilterPtrs パラメーターで渡された各ペイロードフィルターに対応するブール値の配列で、複数の条件が指定されている場合にイベントをどのように扱うかを示します。このパラメーターは、同一のイベントに対して複数のペイロードフィルターが指定されている状況にのみ影響します。ブール値が TRUE の場合、フィルターで指定された条件のいずれかが TRUE であれば、イベントはセッションに書き込まれます。同一のイベント ID またはイベントバージョンに対する 1 つ以上のフィルターでこのフラグが TRUE に設定されている場合、イベントはそのイベントに対してフラグが設定されたすべてのフィルターが満たされた場合にのみ書き込まれます。ブール値が FALSE の場合、フィルターで指定されたすべての条件が TRUE である場合にのみ、イベントはセッションに書き込まれます。同一のイベント ID またはイベントバージョンに対する 1 つ以上のフィルターでこのフラグが FALSE に設定されている場合、フラグが設定されていないフィルターのいずれかが満たされれば、イベントは書き込まれます。
EventFilterDescriptor	EVENT_FILTER_DESCRIPTOR*	out	EnableTraceEx2 関数で使用する EVENT_FILTER_DESCRIPTOR 構造体へのポインター。EVENT_FILTER_DESCRIPTOR 構造体には、この関数によって割り当てられた集約済みペイロードフィルターへのポインターが格納されます。この EVENT_FILTER_DESCRIPTOR 構造体を EnableTraceEx2 関数で使用し終えたら、TdhCleanupPayloadEventFilterDescriptor 関数を呼び出して、割り当てられたメモリを解放する必要があります。

戻り値の型: DWORD

公式ドキュメント

単一のプロバイダーに対する複数のペイロードフィルターを、EnableTraceEx2 関数で使用するための単一のデータ構造に集約します。

戻り値

成功した場合は ERROR_SUCCESS を返します。それ以外の場合、この関数は以下のいずれかの戻り値コード(およびその他のコード)を返します。

戻り値コード	説明
ERROR_INVALID_PARAMETER	1 つ以上のパラメーターが無効です。
ERROR_NOT_ENOUGH_MEMORY	集約済みペイロードフィルターを作成するためのメモリを割り当てられません。

解説(Remarks)

Windows 8.1、Windows Server 2012 R2 以降では、EnableTraceEx2 関数でイベントペイロードフィルターを使用して、ロガーセッション内のイベントの特定の内容に基づいてフィルタリングできます。

TdhAggregatePayloadFilters 関数は、単一のプロバイダーに対するペイロードフィルターを、EnableTraceEx2 関数で使用するための単一のデータ構造に集約します。TdhAggregatePayloadFilters は、集約済みペイロードフィルター用の不透明なデータ構造を割り当てて値を設定します。集約済みペイロードフィルターが不要になったら、TdhCleanupPayloadEventFilterDescriptor 関数を使用して、返された EVENT_FILTER_DESCRIPTOR 構造体内の集約済みペイロードフィルターに割り当てられたメモリを解放します。

例

ロガーセッション内の特定の条件でフィルタリングするためにペイロードフィルターを集約する TdhAggregatePayloadFilters 関数の使用例については、EnableTraceEx2 関数の例を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// TDH.dll
#include <windows.h>

DWORD TdhAggregatePayloadFilters(
    DWORD PayloadFilterCount,
    void** PayloadFilterPtrs,
    BOOLEAN* EventMatchALLFlags,   // optional
    EVENT_FILTER_DESCRIPTOR* EventFilterDescriptor
);

[DllImport("TDH.dll", ExactSpelling = true)]
static extern uint TdhAggregatePayloadFilters(
    uint PayloadFilterCount,   // DWORD
    IntPtr PayloadFilterPtrs,   // void**
    IntPtr EventMatchALLFlags,   // BOOLEAN* optional
    IntPtr EventFilterDescriptor   // EVENT_FILTER_DESCRIPTOR* out
);

<DllImport("TDH.dll", ExactSpelling:=True)>
Public Shared Function TdhAggregatePayloadFilters(
    PayloadFilterCount As UInteger,   ' DWORD
    PayloadFilterPtrs As IntPtr,   ' void**
    EventMatchALLFlags As IntPtr,   ' BOOLEAN* optional
    EventFilterDescriptor As IntPtr   ' EVENT_FILTER_DESCRIPTOR* out
) As UInteger
End Function

' PayloadFilterCount : DWORD
' PayloadFilterPtrs : void**
' EventMatchALLFlags : BOOLEAN* optional
' EventFilterDescriptor : EVENT_FILTER_DESCRIPTOR* out
Declare PtrSafe Function TdhAggregatePayloadFilters Lib "tdh" ( _
    ByVal PayloadFilterCount As Long, _
    ByVal PayloadFilterPtrs As LongPtr, _
    ByVal EventMatchALLFlags As LongPtr, _
    ByVal EventFilterDescriptor As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

TdhAggregatePayloadFilters = ctypes.windll.tdh.TdhAggregatePayloadFilters
TdhAggregatePayloadFilters.restype = wintypes.DWORD
TdhAggregatePayloadFilters.argtypes = [
    wintypes.DWORD,  # PayloadFilterCount : DWORD
    ctypes.c_void_p,  # PayloadFilterPtrs : void**
    ctypes.c_void_p,  # EventMatchALLFlags : BOOLEAN* optional
    ctypes.c_void_p,  # EventFilterDescriptor : EVENT_FILTER_DESCRIPTOR* out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('TDH.dll')
TdhAggregatePayloadFilters = Fiddle::Function.new(
  lib['TdhAggregatePayloadFilters'],
  [
    -Fiddle::TYPE_INT,  # PayloadFilterCount : DWORD
    Fiddle::TYPE_VOIDP,  # PayloadFilterPtrs : void**
    Fiddle::TYPE_VOIDP,  # EventMatchALLFlags : BOOLEAN* optional
    Fiddle::TYPE_VOIDP,  # EventFilterDescriptor : EVENT_FILTER_DESCRIPTOR* out
  ],
  -Fiddle::TYPE_INT)

#[link(name = "tdh")]
extern "system" {
    fn TdhAggregatePayloadFilters(
        PayloadFilterCount: u32,  // DWORD
        PayloadFilterPtrs: *mut *mut (),  // void**
        EventMatchALLFlags: *mut u8,  // BOOLEAN* optional
        EventFilterDescriptor: *mut EVENT_FILTER_DESCRIPTOR  // EVENT_FILTER_DESCRIPTOR* out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("TDH.dll")]
public static extern uint TdhAggregatePayloadFilters(uint PayloadFilterCount, IntPtr PayloadFilterPtrs, IntPtr EventMatchALLFlags, IntPtr EventFilterDescriptor);
"@
$api = Add-Type -MemberDefinition $sig -Name 'TDH_TdhAggregatePayloadFilters' -Namespace Win32 -PassThru
# $api::TdhAggregatePayloadFilters(PayloadFilterCount, PayloadFilterPtrs, EventMatchALLFlags, EventFilterDescriptor)

#uselib "TDH.dll"
#func global TdhAggregatePayloadFilters "TdhAggregatePayloadFilters" sptr, sptr, sptr, sptr
; TdhAggregatePayloadFilters PayloadFilterCount, PayloadFilterPtrs, varptr(EventMatchALLFlags), varptr(EventFilterDescriptor)   ; 戻り値は stat
; PayloadFilterCount : DWORD -> "sptr"
; PayloadFilterPtrs : void** -> "sptr"
; EventMatchALLFlags : BOOLEAN* optional -> "sptr"
; EventFilterDescriptor : EVENT_FILTER_DESCRIPTOR* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "TDH.dll"
#cfunc global TdhAggregatePayloadFilters "TdhAggregatePayloadFilters" int, sptr, var, var
; res = TdhAggregatePayloadFilters(PayloadFilterCount, PayloadFilterPtrs, EventMatchALLFlags, EventFilterDescriptor)
; PayloadFilterCount : DWORD -> "int"
; PayloadFilterPtrs : void** -> "sptr"
; EventMatchALLFlags : BOOLEAN* optional -> "var"
; EventFilterDescriptor : EVENT_FILTER_DESCRIPTOR* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "TDH.dll"
#cfunc global TdhAggregatePayloadFilters "TdhAggregatePayloadFilters" int, sptr, sptr, sptr
; res = TdhAggregatePayloadFilters(PayloadFilterCount, PayloadFilterPtrs, varptr(EventMatchALLFlags), varptr(EventFilterDescriptor))
; PayloadFilterCount : DWORD -> "int"
; PayloadFilterPtrs : void** -> "sptr"
; EventMatchALLFlags : BOOLEAN* optional -> "sptr"
; EventFilterDescriptor : EVENT_FILTER_DESCRIPTOR* out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。