PAYLOAD_FILTER_PREDICATE
構造体サイズ=各フィールドのバイト数(x64/x86 で異なる場合は x64/x86 と併記)。x64/x86 列=フィールドのバイトオフセット(HSPで dupptr / lpoke / wpoke 等に使用)。
フィールド
| フィールド | 型 | サイズ | x64 | x86 | 説明 | ||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| FieldName | LPWSTR | 8/4 | +0 | +0 | パッケージマニフェスト内でフィルター対象とするフィールドの名前です。 | ||||||||||||||||||||||||||||||
| CompareOp | WORD | 2 | +8 | +4 | 比較に使用するペイロード演算子です。 このメンバーには、Tdh.h ヘッダーファイルで定義されている PAYLOAD_OPERATOR 列挙型の値のいずれかを指定できます。
| ||||||||||||||||||||||||||||||
| Value | LPWSTR | 8/4 | +16 | +8 | CompareOp メンバーに応じて比較の対象となる、1 つまたは複数の値を含む文字列です。 |
公式ドキュメント
トレースセッション内で単一のフィールドをフィルター処理する方法を記述する、イベントペイロードフィルター述語を定義します。
解説(Remarks)
Windows 8.1、Windows Server 2012 R2 以降では、イベントペイロードフィルターを EnableTraceEx2 関数、および ENABLE_TRACE_PARAMETERS 構造体と EVENT_FILTER_DESCRIPTOR 構造体で使用して、ロガーセッション内のイベントの特定の内容に基づくフィルター処理を行えます。
PAYLOAD_FILTER_PREDICATE 構造体は TdhCreatePayloadFilter 関数と共に使用し、EnableTraceEx2 関数で使用する単一ペイロード用の単一のペイロードフィルターを作成します。 単一のペイロードフィルターは、TdhAggregatePayloadFilters 関数を使用して他の単一のペイロードフィルターと集約することもできます。
各フィールドにはプロバイダーマニフェストで指定された型があり、そのフィールドに対してフィルター処理を行うために PAYLOAD_FILTER_PREDICATE 構造体の Fieldname メンバーで使用できます。
CompareOp メンバーは、ペイロードフィルター処理に使用する演算子を指定します。ペイロードフィルター処理では、文字列 (GUID を含む) および整数 (TDH_INTYPE_FILETIME を含む) に対するフィルター処理がサポートされます。 浮動小数点数、バイナリ BLOB (TDH_INTYPE_POINTER を含む)、および構造化データ (SID と SYSTEMTIME) に対するフィルター処理はサポートされません。
Value メンバーには、Fieldname メンバーの値と比較する 1 つまたは複数の値を表す文字列を格納します。Value メンバーは、文字列からマニフェストで指定された Fieldname メンバーの型に変換されます。
文字列の比較はすべて大文字と小文字を区別しません。 Value メンバーの文字列は UNICODE ですが、マニフェストで指定された型が ANSI の場合は ANSI に変換されます。
GUID を格納する Fieldname メンバーは、CompareOp メンバーのペイロード演算子が PAYLOADFIELD_IS または PAYLOADFIELD_ISNOT の場合にのみ比較できます。Value メンバーで GUID を表す文字列には、中かっこを含めなければなりません (例: {00000000-0000-0000-0000-000000000000})。
例
PAYLOAD_FILTER_PREDICATE 構造体と TdhCreatePayloadFilter 関数を使用して、ロガーセッションで特定の条件に基づくフィルター処理を行うためのペイロードフィルターを作成する例については、 EnableTraceEx2 関数の例を参照してください。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での定義
#include <windows.h>
// PAYLOAD_FILTER_PREDICATE (x64 24 / x86 12 バイト)
typedef struct PAYLOAD_FILTER_PREDICATE {
LPWSTR FieldName;
WORD CompareOp;
LPWSTR Value;
} PAYLOAD_FILTER_PREDICATE;using System;
using System.Runtime.InteropServices;
[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
public struct PAYLOAD_FILTER_PREDICATE
{
public IntPtr FieldName;
public ushort CompareOp;
public IntPtr Value;
}Imports System.Runtime.InteropServices
<StructLayout(LayoutKind.Sequential, CharSet:=CharSet.Unicode)>
Public Structure PAYLOAD_FILTER_PREDICATE
Public FieldName As IntPtr
Public CompareOp As UShort
Public Value As IntPtr
End Structureimport ctypes
from ctypes import wintypes
class PAYLOAD_FILTER_PREDICATE(ctypes.Structure):
_fields_ = [
("FieldName", ctypes.c_void_p),
("CompareOp", ctypes.c_ushort),
("Value", ctypes.c_void_p),
]#[repr(C)]
pub struct PAYLOAD_FILTER_PREDICATE {
pub FieldName: *mut core::ffi::c_void,
pub CompareOp: u16,
pub Value: *mut core::ffi::c_void,
}import "golang.org/x/sys/windows"
type PAYLOAD_FILTER_PREDICATE struct {
FieldName uintptr
CompareOp uint16
Value uintptr
}type
PAYLOAD_FILTER_PREDICATE = record
FieldName: Pointer;
CompareOp: Word;
Value: Pointer;
end;const PAYLOAD_FILTER_PREDICATE = extern struct {
FieldName: ?*anyopaque,
CompareOp: u16,
Value: ?*anyopaque,
};type
PAYLOAD_FILTER_PREDICATE {.bycopy.} = object
FieldName: pointer
CompareOp: uint16
Value: pointerstruct PAYLOAD_FILTER_PREDICATE
{
void* FieldName;
ushort CompareOp;
void* Value;
}HSP用 定義
HSP3.7/3.8 は構造体機能が無いため4byte整数配列(dim)+peek/poke で操作(32/64bitでサイズ・位置が異なる場合はタブで分割)。IronHSP は NSTRUCT(#defstruct/stdim/->)で32/64bit共通。
; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x86 レイアウト)
; PAYLOAD_FILTER_PREDICATE サイズ: 12 バイト(x86)
dim st, 3 ; 4byte整数×3(構造体サイズ 12 / 4 切り上げ)
; FieldName : LPWSTR (+0, 4byte) st.0 = 値 / 値 = st.0 (lpoke/lpeek も可)
; CompareOp : WORD (+4, 2byte) wpoke st,4,値 / 値 = wpeek(st,4)
; Value : LPWSTR (+8, 4byte) st.2 = 値 / 値 = st.2 (lpoke/lpeek も可)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x64 レイアウト)
; PAYLOAD_FILTER_PREDICATE サイズ: 24 バイト(x64)
dim st, 6 ; 4byte整数×6(構造体サイズ 24 / 4 切り上げ)
; FieldName : LPWSTR (+0, 8byte) qpoke st,0,値 / qpeek(st,0) ※IronHSPのみ。3.7/3.8は lpoke st,0,下位 : lpoke st,4,上位
; CompareOp : WORD (+8, 2byte) wpoke st,8,値 / 値 = wpeek(st,8)
; Value : LPWSTR (+16, 8byte) qpoke st,16,値 / qpeek(st,16) ※IronHSPのみ。3.7/3.8は lpoke st,16,下位 : lpoke st,20,上位
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。; IronHSP は NSTRUCT(構造体)をサポート。32bit/64bit どちらでも同じコードで動作します。
#defstruct global PAYLOAD_FILTER_PREDICATE
#field intptr FieldName
#field short CompareOp
#field intptr Value
#endstruct
stdim st, PAYLOAD_FILTER_PREDICATE ; NSTRUCT 変数を確保
st->CompareOp = 100
mes "CompareOp=" + st->CompareOp