Win32 API 日本語リファレンス
ホーム › System.Diagnostics.Etw › EventWriteEx

EventWriteEx

関数
フィルターやフラグを指定して拡張的にETWイベントを記録する。
DLLADVAPI32.dll呼出規約winapi対応OSWindows 7 以降
📘 Microsoft Learn (日本語) · English

シグネチャ

// 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
);

パラメーター

名前型方向説明
RegHandleREGHANDLEinプロバイダーの登録ハンドルです。このハンドルは EventRegister から取得します。 生成されるイベントは、このハンドルに関連付けられた ProviderId を使用します。
EventDescriptorEVENT_DESCRIPTOR*in

ID、Version、Level、Keyword、Channel、Opcode、Task を含むイベント情報 (メタデータ) を保持する EVENT_DESCRIPTOR です。

重要

ProviderId、Level、Keyword はイベントをフィルタリングするための主要な手段です。 他の種類のフィルタリングも可能ですが、オーバーヘッドははるかに大きくなります。 すべてのイベントに対して、必ず 0 以外の Level と Keyword を割り当ててください。

FilterULONGLONGin

64 ビットのビットマスク値です。セットされた各ビットは、このイベントを特定のトレース セッションから 除外することを示します。

Filter パラメーターは、 EnableCallback の FilterData に 基づいてカスタム イベント フィルタリングを実行するイベント プロバイダーで使用されます。

カスタム イベント フィルターをサポートしない場合、またはイベントをすべてのトレース セッションに 書き込む必要がある場合は、Filter を 0 に設定します。それ以外の場合は、イベントを受け取るべきでない セッションの識別子のビット単位の OR を Filter に設定します。

FlagsDWORDin

通常のイベント処理では、Flags を 0 に設定します。

特別なイベント処理を行う場合は、Flags を EVENT_WRITE_FLAG 値の組み合わせに設定します。

ActivityIdGUID*inoptional

このイベントの 128 ビットのアクティビティ ID への省略可能なポインターです。これが NULL 以外の場合、 EventWriteEx は指定された値をイベントのアクティビティ ID として使用します。これが NULL の場合、 EventWriteEx は現在のスレッドのアクティビティ ID を使用します。

トレース処理ツールは、イベントのアクティビティ ID を使用して、イベントをアクティビティと呼ばれる グループに整理できます。アクティビティ ID の詳細については、 EventActivityIdControl を 参照してください。

RelatedActivityIdGUID*inoptional

このイベントのアクティビティの親となる 128 ビットのアクティビティ ID への省略可能なポインターです。 これが NULL 以外の場合、EventWriteEx は指定された値をイベントの関連アクティビティ ID として 使用します。これが NULL の場合、イベントは関連アクティビティ ID を持ちません。関連アクティビティ ID は 通常、アクティビティの START イベント (アクティビティの最初のイベントで、Opcode = START でログに 記録されるもの) に設定されます。

トレース処理ツールは、イベントの関連アクティビティ ID を使用して、アクティビティ間の関係を判断できます (例: 関連アクティビティが、新しく開始されたアクティビティの親であるなど)。関連アクティビティ ID の 詳細については、 EventActivityIdControl を 参照してください。

UserDataCountDWORDinUserData 内の EVENT_DATA_DESCRIPTOR 構造体の数です。最大数は 128 です。
UserDataEVENT_DATA_DESCRIPTOR*inoptional

イベントに含めるデータを記述する UserDataCount 個の EVENT_DATA_DESCRIPTOR 構造体の配列です。UserDataCount が 0 の場合、UserData は NULL でかまいません。

各 EVENT_DATA_DESCRIPTOR は、イベントに含める 1 つのメモリ ブロックを記述します。指定された ブロックは、パディングやアラインメントなしで順番に連結され、イベントの内容を形成します。マニフェスト ベースのデコードを使用する場合、イベントの内容は、マニフェスト内のイベントに関連付けられたテンプレートで 指定されたレイアウトと一致している必要があります。

戻り値の型: DWORD

公式ドキュメント

アクティビティ ID、省略可能な関連アクティビティ ID を伴う ETW イベントを書き込みます。

戻り値

成功した場合は ERROR_SUCCESS を、それ以外の場合はエラー コードを返します。考えられるエラー コードには 次のものがあります。

エラー コードは、主にデバッグおよび診断シナリオでの使用を目的としています。ほとんどの運用コードは、 ETW イベントを書き込めなかった場合でも実行を継続し、イベントの報告を続けるべきです。したがって、 リリース ビルドでは通常、エラー コードを無視するのが適切です。

解説(Remarks)

ほとんどのイベント プロバイダーは、EventWriteEx を直接呼び出すことはありません。代わりに、 ほとんどのイベント プロバイダーは、EventRegister、EventWriteEx、EventUnregister への 呼び出しをラップする ETW フレームワークを使用して実装されます。たとえば、 イベント マニフェストの作成 を行ったうえで、 メッセージ コンパイラー を使用してイベント用の C/C++ コードを生成したり、マニフェストを不要にするために TraceLogging を使用したりできます。

EventWriteEx は、ProviderId (RegHandle から決定されます)、Level、Keyword、その他のイベント 特性に基づいて、イベントを適切なトレース セッションへルーティングします。このイベントを記録している トレース セッションがない場合、この関数は何も行わず、ERROR_SUCCESS を返します。

どのトレース セッションにも記録されないイベントのパフォーマンスへの影響を軽減するには、データを準備して EventWriteEx を呼び出す前に、 EventEnabled を呼び出して、いずれかの トレース セッションがイベントを記録しているかどうかを判断できます。

プロバイダーは、セッションがイベント データに基づいてイベントをフィルタリングするために使用する フィルターを定義できます。コア フィルターは Level と Keyword に基づいています。イベント プロバイダーは、 より複雑なフィルターをサポートできます。イベント プロバイダーは、 EnableCallback の FilterData パラメーターからフィルター情報を受け取ることができます。プロバイダーはフィルターを評価し、 EventWriteEx の Filter パラメーターを使用して、特定のトレース セッションがフィルターを通過 しなかったため、イベントを受け取るべきでないことを示すことができます。

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

各言語での呼び出し定義

// 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 は未対応)。
出力引数: 
; 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 方式にも切替可。
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)。
const std = @import("std");

extern "advapi32" fn EventWriteEx(
    RegHandle: i64, // REGHANDLE
    EventDescriptor: [*c]EVENT_DESCRIPTOR, // EVENT_DESCRIPTOR*
    Filter: u64, // ULONGLONG
    Flags: u32, // DWORD
    ActivityId: [*c]GUID, // GUID* optional
    RelatedActivityId: [*c]GUID, // GUID* optional
    UserDataCount: u32, // DWORD
    UserData: [*c]EVENT_DATA_DESCRIPTOR // EVENT_DATA_DESCRIPTOR* optional
) callconv(std.os.windows.WINAPI) u32;
proc EventWriteEx(
    RegHandle: int64,  # REGHANDLE
    EventDescriptor: ptr EVENT_DESCRIPTOR,  # EVENT_DESCRIPTOR*
    Filter: uint64,  # ULONGLONG
    Flags: uint32,  # DWORD
    ActivityId: ptr GUID,  # GUID* optional
    RelatedActivityId: ptr GUID,  # GUID* optional
    UserDataCount: uint32,  # DWORD
    UserData: ptr EVENT_DATA_DESCRIPTOR  # EVENT_DATA_DESCRIPTOR* optional
): uint32 {.importc: "EventWriteEx", stdcall, dynlib: "ADVAPI32.dll".}
pragma(lib, "advapi32");
extern(Windows)
uint EventWriteEx(
    long RegHandle,   // REGHANDLE
    EVENT_DESCRIPTOR* EventDescriptor,   // EVENT_DESCRIPTOR*
    ulong Filter,   // ULONGLONG
    uint Flags,   // DWORD
    GUID* ActivityId,   // GUID* optional
    GUID* RelatedActivityId,   // GUID* optional
    uint UserDataCount,   // DWORD
    EVENT_DATA_DESCRIPTOR* UserData   // EVENT_DATA_DESCRIPTOR* optional
);
ccall((:EventWriteEx, "ADVAPI32.dll"), stdcall, UInt32,
      (Int64, Ptr{EVENT_DESCRIPTOR}, UInt64, UInt32, Ptr{GUID}, Ptr{GUID}, UInt32, Ptr{EVENT_DATA_DESCRIPTOR}),
      RegHandle, EventDescriptor, Filter, Flags, ActivityId, RelatedActivityId, UserDataCount, UserData)
# RegHandle : REGHANDLE -> Int64
# EventDescriptor : EVENT_DESCRIPTOR* -> Ptr{EVENT_DESCRIPTOR}
# Filter : ULONGLONG -> UInt64
# Flags : DWORD -> UInt32
# ActivityId : GUID* optional -> Ptr{GUID}
# RelatedActivityId : GUID* optional -> Ptr{GUID}
# UserDataCount : DWORD -> UInt32
# UserData : EVENT_DATA_DESCRIPTOR* optional -> Ptr{EVENT_DATA_DESCRIPTOR}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t EventWriteEx(
    int64_t RegHandle,
    void* EventDescriptor,
    uint64_t Filter,
    uint32_t Flags,
    void* ActivityId,
    void* RelatedActivityId,
    uint32_t UserDataCount,
    void* UserData);
]]
local advapi32 = ffi.load("advapi32")
-- advapi32.EventWriteEx(RegHandle, EventDescriptor, Filter, Flags, ActivityId, RelatedActivityId, UserDataCount, UserData)
-- RegHandle : REGHANDLE
-- EventDescriptor : EVENT_DESCRIPTOR*
-- Filter : ULONGLONG
-- Flags : DWORD
-- ActivityId : GUID* optional
-- RelatedActivityId : GUID* optional
-- UserDataCount : DWORD
-- UserData : EVENT_DATA_DESCRIPTOR* optional
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('ADVAPI32.dll');
const EventWriteEx = lib.func('__stdcall', 'EventWriteEx', 'uint32_t', ['int64_t', 'void *', 'uint64_t', 'uint32_t', 'void *', 'void *', 'uint32_t', 'void *']);
// EventWriteEx(RegHandle, EventDescriptor, Filter, Flags, ActivityId, RelatedActivityId, UserDataCount, UserData)
// RegHandle : REGHANDLE -> 'int64_t'
// EventDescriptor : EVENT_DESCRIPTOR* -> 'void *'
// Filter : ULONGLONG -> 'uint64_t'
// Flags : DWORD -> 'uint32_t'
// ActivityId : GUID* optional -> 'void *'
// RelatedActivityId : GUID* optional -> 'void *'
// UserDataCount : DWORD -> 'uint32_t'
// UserData : EVENT_DATA_DESCRIPTOR* optional -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("ADVAPI32.dll", {
  EventWriteEx: { parameters: ["i64", "pointer", "u64", "u32", "pointer", "pointer", "u32", "pointer"], result: "u32" },
});
// lib.symbols.EventWriteEx(RegHandle, EventDescriptor, Filter, Flags, ActivityId, RelatedActivityId, UserDataCount, UserData)
// RegHandle : REGHANDLE -> "i64"
// EventDescriptor : EVENT_DESCRIPTOR* -> "pointer"
// Filter : ULONGLONG -> "u64"
// Flags : DWORD -> "u32"
// ActivityId : GUID* optional -> "pointer"
// RelatedActivityId : GUID* optional -> "pointer"
// UserDataCount : DWORD -> "u32"
// UserData : EVENT_DATA_DESCRIPTOR* optional -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t EventWriteEx(
    int64_t RegHandle,
    void* EventDescriptor,
    uint64_t Filter,
    uint32_t Flags,
    void* ActivityId,
    void* RelatedActivityId,
    uint32_t UserDataCount,
    void* UserData);
C, "ADVAPI32.dll");
// $ffi->EventWriteEx(RegHandle, EventDescriptor, Filter, Flags, ActivityId, RelatedActivityId, UserDataCount, UserData);
// RegHandle : REGHANDLE
// EventDescriptor : EVENT_DESCRIPTOR*
// Filter : ULONGLONG
// Flags : DWORD
// ActivityId : GUID* optional
// RelatedActivityId : GUID* optional
// UserDataCount : DWORD
// UserData : EVENT_DATA_DESCRIPTOR* optional
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Advapi32 extends StdCallLibrary {
    Advapi32 INSTANCE = Native.load("advapi32", Advapi32.class);
    int EventWriteEx(
        long RegHandle,   // REGHANDLE
        Pointer EventDescriptor,   // EVENT_DESCRIPTOR*
        long Filter,   // ULONGLONG
        int Flags,   // DWORD
        Pointer ActivityId,   // GUID* optional
        Pointer RelatedActivityId,   // GUID* optional
        int UserDataCount,   // DWORD
        Pointer UserData   // EVENT_DATA_DESCRIPTOR* optional
    );
}
@[Link("advapi32")]
lib LibADVAPI32
  fun EventWriteEx = EventWriteEx(
    RegHandle : Int64,   # REGHANDLE
    EventDescriptor : EVENT_DESCRIPTOR*,   # EVENT_DESCRIPTOR*
    Filter : UInt64,   # ULONGLONG
    Flags : UInt32,   # DWORD
    ActivityId : GUID*,   # GUID* optional
    RelatedActivityId : GUID*,   # GUID* optional
    UserDataCount : UInt32,   # DWORD
    UserData : EVENT_DATA_DESCRIPTOR*   # EVENT_DATA_DESCRIPTOR* optional
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef EventWriteExNative = Uint32 Function(Int64, Pointer<Void>, Uint64, Uint32, Pointer<Void>, Pointer<Void>, Uint32, Pointer<Void>);
typedef EventWriteExDart = int Function(int, Pointer<Void>, int, int, Pointer<Void>, Pointer<Void>, int, Pointer<Void>);
final EventWriteEx = DynamicLibrary.open('ADVAPI32.dll')
    .lookupFunction<EventWriteExNative, EventWriteExDart>('EventWriteEx');
// RegHandle : REGHANDLE -> Int64
// EventDescriptor : EVENT_DESCRIPTOR* -> Pointer<Void>
// Filter : ULONGLONG -> Uint64
// Flags : DWORD -> Uint32
// ActivityId : GUID* optional -> Pointer<Void>
// RelatedActivityId : GUID* optional -> Pointer<Void>
// UserDataCount : DWORD -> Uint32
// UserData : EVENT_DATA_DESCRIPTOR* optional -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
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';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "EventWriteEx"
  c_EventWriteEx :: Int64 -> Ptr () -> Word64 -> Word32 -> Ptr () -> Ptr () -> Word32 -> Ptr () -> IO Word32
-- RegHandle : REGHANDLE -> Int64
-- EventDescriptor : EVENT_DESCRIPTOR* -> Ptr ()
-- Filter : ULONGLONG -> Word64
-- Flags : DWORD -> Word32
-- ActivityId : GUID* optional -> Ptr ()
-- RelatedActivityId : GUID* optional -> Ptr ()
-- UserDataCount : DWORD -> Word32
-- UserData : EVENT_DATA_DESCRIPTOR* optional -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let eventwriteex =
  foreign "EventWriteEx"
    (int64_t @-> (ptr void) @-> uint64_t @-> uint32_t @-> (ptr void) @-> (ptr void) @-> uint32_t @-> (ptr void) @-> returning uint32_t)
(* RegHandle : REGHANDLE -> int64_t *)
(* EventDescriptor : EVENT_DESCRIPTOR* -> (ptr void) *)
(* Filter : ULONGLONG -> uint64_t *)
(* Flags : DWORD -> uint32_t *)
(* ActivityId : GUID* optional -> (ptr void) *)
(* RelatedActivityId : GUID* optional -> (ptr void) *)
(* UserDataCount : DWORD -> uint32_t *)
(* UserData : EVENT_DATA_DESCRIPTOR* optional -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library advapi32 (t "ADVAPI32.dll"))
(cffi:use-foreign-library advapi32)

(cffi:defcfun ("EventWriteEx" event-write-ex :convention :stdcall) :uint32
  (reg-handle :int64)   ; REGHANDLE
  (event-descriptor :pointer)   ; EVENT_DESCRIPTOR*
  (filter :uint64)   ; ULONGLONG
  (flags :uint32)   ; DWORD
  (activity-id :pointer)   ; GUID* optional
  (related-activity-id :pointer)   ; GUID* optional
  (user-data-count :uint32)   ; DWORD
  (user-data :pointer))   ; EVENT_DATA_DESCRIPTOR* optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $EventWriteEx = Win32::API::More->new('ADVAPI32',
    'DWORD EventWriteEx(INT64 RegHandle, LPVOID EventDescriptor, UINT64 Filter, DWORD Flags, LPVOID ActivityId, LPVOID RelatedActivityId, DWORD UserDataCount, LPVOID UserData)');
# my $ret = $EventWriteEx->Call($RegHandle, $EventDescriptor, $Filter, $Flags, $ActivityId, $RelatedActivityId, $UserDataCount, $UserData);
# RegHandle : REGHANDLE -> INT64
# EventDescriptor : EVENT_DESCRIPTOR* -> LPVOID
# Filter : ULONGLONG -> UINT64
# Flags : DWORD -> DWORD
# ActivityId : GUID* optional -> LPVOID
# RelatedActivityId : GUID* optional -> LPVOID
# UserDataCount : DWORD -> DWORD
# UserData : EVENT_DATA_DESCRIPTOR* optional -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

類似 API
使用する型