ホーム › System.Diagnostics.Etw › EventWriteEx

EventWriteEx

関数

フィルターやフラグを指定して拡張的にETWイベントを記録する。

DLLADVAPI32.dll呼出規約winapi対応OSWindows 7 以降

シグネチャ

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

DWORD EventWriteEx(
    REGHANDLE RegHandle,
    const EVENT_DESCRIPTOR* EventDescriptor,
    ULONGLONG Filter,
    DWORD Flags,
    const GUID* ActivityId,   // optional
    const GUID* RelatedActivityId,   // optional
    DWORD UserDataCount,
    EVENT_DATA_DESCRIPTOR* UserData   // optional
);

パラメーター

名前	型	方向
RegHandle	REGHANDLE	in
EventDescriptor	EVENT_DESCRIPTOR*	in
Filter	ULONGLONG	in
Flags	DWORD	in
ActivityId	GUID*	inoptional
RelatedActivityId	GUID*	inoptional
UserDataCount	DWORD	in
UserData	EVENT_DATA_DESCRIPTOR*	inoptional

戻り値の型: DWORD

各言語での呼び出し定義

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

DWORD EventWriteEx(
    REGHANDLE RegHandle,
    const EVENT_DESCRIPTOR* EventDescriptor,
    ULONGLONG Filter,
    DWORD Flags,
    const GUID* ActivityId,   // optional
    const GUID* RelatedActivityId,   // optional
    DWORD UserDataCount,
    EVENT_DATA_DESCRIPTOR* UserData   // optional
);

[DllImport("ADVAPI32.dll", ExactSpelling = true)]
static extern uint EventWriteEx(
    long RegHandle,   // REGHANDLE
    IntPtr EventDescriptor,   // EVENT_DESCRIPTOR*
    ulong Filter,   // ULONGLONG
    uint Flags,   // DWORD
    IntPtr ActivityId,   // GUID* optional
    IntPtr RelatedActivityId,   // GUID* optional
    uint UserDataCount,   // DWORD
    IntPtr UserData   // EVENT_DATA_DESCRIPTOR* optional
);

<DllImport("ADVAPI32.dll", ExactSpelling:=True)>
Public Shared Function EventWriteEx(
    RegHandle As Long,   ' REGHANDLE
    EventDescriptor As IntPtr,   ' EVENT_DESCRIPTOR*
    Filter As ULong,   ' ULONGLONG
    Flags As UInteger,   ' DWORD
    ActivityId As IntPtr,   ' GUID* optional
    RelatedActivityId As IntPtr,   ' GUID* optional
    UserDataCount As UInteger,   ' DWORD
    UserData As IntPtr   ' EVENT_DATA_DESCRIPTOR* optional
) As UInteger
End Function

' RegHandle : REGHANDLE
' EventDescriptor : EVENT_DESCRIPTOR*
' Filter : ULONGLONG
' Flags : DWORD
' ActivityId : GUID* optional
' RelatedActivityId : GUID* optional
' UserDataCount : DWORD
' UserData : EVENT_DATA_DESCRIPTOR* optional
Declare PtrSafe Function EventWriteEx Lib "advapi32" ( _
    ByVal RegHandle As LongLong, _
    ByVal EventDescriptor As LongPtr, _
    ByVal Filter As LongLong, _
    ByVal Flags As Long, _
    ByVal ActivityId As LongPtr, _
    ByVal RelatedActivityId As LongPtr, _
    ByVal UserDataCount As Long, _
    ByVal UserData As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

EventWriteEx = ctypes.windll.advapi32.EventWriteEx
EventWriteEx.restype = wintypes.DWORD
EventWriteEx.argtypes = [
    ctypes.c_longlong,  # RegHandle : REGHANDLE
    ctypes.c_void_p,  # EventDescriptor : EVENT_DESCRIPTOR*
    ctypes.c_ulonglong,  # Filter : ULONGLONG
    wintypes.DWORD,  # Flags : DWORD
    ctypes.c_void_p,  # ActivityId : GUID* optional
    ctypes.c_void_p,  # RelatedActivityId : GUID* optional
    wintypes.DWORD,  # UserDataCount : DWORD
    ctypes.c_void_p,  # UserData : EVENT_DATA_DESCRIPTOR* optional
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ADVAPI32.dll')
EventWriteEx = Fiddle::Function.new(
  lib['EventWriteEx'],
  [
    Fiddle::TYPE_LONG_LONG,  # RegHandle : REGHANDLE
    Fiddle::TYPE_VOIDP,  # EventDescriptor : EVENT_DESCRIPTOR*
    -Fiddle::TYPE_LONG_LONG,  # Filter : ULONGLONG
    -Fiddle::TYPE_INT,  # Flags : DWORD
    Fiddle::TYPE_VOIDP,  # ActivityId : GUID* optional
    Fiddle::TYPE_VOIDP,  # RelatedActivityId : GUID* optional
    -Fiddle::TYPE_INT,  # UserDataCount : DWORD
    Fiddle::TYPE_VOIDP,  # UserData : EVENT_DATA_DESCRIPTOR* optional
  ],
  -Fiddle::TYPE_INT)

#[link(name = "advapi32")]
extern "system" {
    fn EventWriteEx(
        RegHandle: i64,  // REGHANDLE
        EventDescriptor: *const EVENT_DESCRIPTOR,  // EVENT_DESCRIPTOR*
        Filter: u64,  // ULONGLONG
        Flags: u32,  // DWORD
        ActivityId: *const GUID,  // GUID* optional
        RelatedActivityId: *const GUID,  // GUID* optional
        UserDataCount: u32,  // DWORD
        UserData: *mut EVENT_DATA_DESCRIPTOR  // EVENT_DATA_DESCRIPTOR* optional
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("ADVAPI32.dll")]
public static extern uint EventWriteEx(long RegHandle, IntPtr EventDescriptor, ulong Filter, uint Flags, IntPtr ActivityId, IntPtr RelatedActivityId, uint UserDataCount, IntPtr UserData);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_EventWriteEx' -Namespace Win32 -PassThru
# $api::EventWriteEx(RegHandle, EventDescriptor, Filter, Flags, ActivityId, RelatedActivityId, UserDataCount, UserData)

#uselib "ADVAPI32.dll"
#func global EventWriteEx "EventWriteEx" sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr
; EventWriteEx RegHandle, varptr(EventDescriptor), Filter, Flags, varptr(ActivityId), varptr(RelatedActivityId), UserDataCount, varptr(UserData)   ; 戻り値は stat
; RegHandle : REGHANDLE -> "sptr"
; EventDescriptor : EVENT_DESCRIPTOR* -> "sptr"
; Filter : ULONGLONG -> "sptr"
; Flags : DWORD -> "sptr"
; ActivityId : GUID* optional -> "sptr"
; RelatedActivityId : GUID* optional -> "sptr"
; UserDataCount : DWORD -> "sptr"
; UserData : EVENT_DATA_DESCRIPTOR* optional -> "sptr"
; ※HSP3.7は int64 引数(64bit値渡し)に非対応です。
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "ADVAPI32.dll"
#cfunc global EventWriteEx "EventWriteEx" int64, var, int64, int, var, var, int, var
; res = EventWriteEx(RegHandle, EventDescriptor, Filter, Flags, ActivityId, RelatedActivityId, UserDataCount, UserData)
; RegHandle : REGHANDLE -> "int64"
; EventDescriptor : EVENT_DESCRIPTOR* -> "var"
; Filter : ULONGLONG -> "int64"
; Flags : DWORD -> "int"
; ActivityId : GUID* optional -> "var"
; RelatedActivityId : GUID* optional -> "var"
; UserDataCount : DWORD -> "int"
; UserData : EVENT_DATA_DESCRIPTOR* optional -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
; ※int64 引数の DLL 値渡しは x64 ランタイム(hsp3_64)のみ対応(x86 は未対応)。#uselib "ADVAPI32.dll"
#cfunc global EventWriteEx "EventWriteEx" int64, sptr, int64, int, sptr, sptr, int, sptr
; res = EventWriteEx(RegHandle, varptr(EventDescriptor), Filter, Flags, varptr(ActivityId), varptr(RelatedActivityId), UserDataCount, varptr(UserData))
; RegHandle : REGHANDLE -> "int64"
; EventDescriptor : EVENT_DESCRIPTOR* -> "sptr"
; Filter : ULONGLONG -> "int64"
; Flags : DWORD -> "int"
; ActivityId : GUID* optional -> "sptr"
; RelatedActivityId : GUID* optional -> "sptr"
; UserDataCount : DWORD -> "int"
; UserData : EVENT_DATA_DESCRIPTOR* optional -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; ※int64 引数の DLL 値渡しは x64 ランタイム(hsp3_64)のみ対応(x86 は未対応)。

出力引数:

; DWORD EventWriteEx(REGHANDLE RegHandle, EVENT_DESCRIPTOR* EventDescriptor, ULONGLONG Filter, DWORD Flags, GUID* ActivityId, GUID* RelatedActivityId, DWORD UserDataCount, EVENT_DATA_DESCRIPTOR* UserData)
#uselib "ADVAPI32.dll"
#cfunc global EventWriteEx "EventWriteEx" int64, var, int64, int, var, var, int, var
; res = EventWriteEx(RegHandle, EventDescriptor, Filter, Flags, ActivityId, RelatedActivityId, UserDataCount, UserData)
; RegHandle : REGHANDLE -> "int64"
; EventDescriptor : EVENT_DESCRIPTOR* -> "var"
; Filter : ULONGLONG -> "int64"
; Flags : DWORD -> "int"
; ActivityId : GUID* optional -> "var"
; RelatedActivityId : GUID* optional -> "var"
; UserDataCount : DWORD -> "int"
; UserData : EVENT_DATA_DESCRIPTOR* optional -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; DWORD EventWriteEx(REGHANDLE RegHandle, EVENT_DESCRIPTOR* EventDescriptor, ULONGLONG Filter, DWORD Flags, GUID* ActivityId, GUID* RelatedActivityId, DWORD UserDataCount, EVENT_DATA_DESCRIPTOR* UserData)
#uselib "ADVAPI32.dll"
#cfunc global EventWriteEx "EventWriteEx" int64, intptr, int64, int, intptr, intptr, int, intptr
; res = EventWriteEx(RegHandle, varptr(EventDescriptor), Filter, Flags, varptr(ActivityId), varptr(RelatedActivityId), UserDataCount, varptr(UserData))
; RegHandle : REGHANDLE -> "int64"
; EventDescriptor : EVENT_DESCRIPTOR* -> "intptr"
; Filter : ULONGLONG -> "int64"
; Flags : DWORD -> "int"
; ActivityId : GUID* optional -> "intptr"
; RelatedActivityId : GUID* optional -> "intptr"
; UserDataCount : DWORD -> "int"
; UserData : EVENT_DATA_DESCRIPTOR* optional -> "intptr"
; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。

import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	advapi32 = windows.NewLazySystemDLL("ADVAPI32.dll")
	procEventWriteEx = advapi32.NewProc("EventWriteEx")
)

// RegHandle (REGHANDLE), EventDescriptor (EVENT_DESCRIPTOR*), Filter (ULONGLONG), Flags (DWORD), ActivityId (GUID* optional), RelatedActivityId (GUID* optional), UserDataCount (DWORD), UserData (EVENT_DATA_DESCRIPTOR* optional)
r1, _, err := procEventWriteEx.Call(
	uintptr(RegHandle),
	uintptr(EventDescriptor),
	uintptr(Filter),
	uintptr(Flags),
	uintptr(ActivityId),
	uintptr(RelatedActivityId),
	uintptr(UserDataCount),
	uintptr(UserData),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD

function EventWriteEx(
  RegHandle: Int64;   // REGHANDLE
  EventDescriptor: Pointer;   // EVENT_DESCRIPTOR*
  Filter: UInt64;   // ULONGLONG
  Flags: DWORD;   // DWORD
  ActivityId: PGUID;   // GUID* optional
  RelatedActivityId: PGUID;   // GUID* optional
  UserDataCount: DWORD;   // DWORD
  UserData: Pointer   // EVENT_DATA_DESCRIPTOR* optional
): DWORD; stdcall;
  external 'ADVAPI32.dll' name 'EventWriteEx';

result := DllCall("ADVAPI32\EventWriteEx"
    , "Int64", RegHandle   ; REGHANDLE
    , "Ptr", EventDescriptor   ; EVENT_DESCRIPTOR*
    , "Int64", Filter   ; ULONGLONG
    , "UInt", Flags   ; DWORD
    , "Ptr", ActivityId   ; GUID* optional
    , "Ptr", RelatedActivityId   ; GUID* optional
    , "UInt", UserDataCount   ; DWORD
    , "Ptr", UserData   ; EVENT_DATA_DESCRIPTOR* optional
    , "UInt")   ; return: DWORD

●EventWriteEx(RegHandle, EventDescriptor, Filter, Flags, ActivityId, RelatedActivityId, UserDataCount, UserData) = DLL("ADVAPI32.dll", "dword EventWriteEx(int64, void*, qword, dword, void*, void*, dword, void*)")
# 呼び出し: EventWriteEx(RegHandle, EventDescriptor, Filter, Flags, ActivityId, RelatedActivityId, UserDataCount, UserData)
# RegHandle : REGHANDLE -> "int64"
# EventDescriptor : EVENT_DESCRIPTOR* -> "void*"
# Filter : ULONGLONG -> "qword"
# Flags : DWORD -> "dword"
# ActivityId : GUID* optional -> "void*"
# RelatedActivityId : GUID* optional -> "void*"
# UserDataCount : DWORD -> "dword"
# UserData : EVENT_DATA_DESCRIPTOR* optional -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。