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

TraceEvent

関数
クラシックETWイベントをトレースセッションに記録する。
DLLADVAPI32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

WIN32_ERROR TraceEvent(
    ULONGLONG TraceHandle,
    EVENT_TRACE_HEADER* EventTrace
);

パラメーター

名前方向説明
TraceHandleULONGLONGinイベントを記録するイベントトレースセッションへのハンドル。プロバイダーは、 ControlCallback 実装内で GetTraceLoggerHandle 関数を呼び出すことで このハンドルを取得します。
EventTraceEVENT_TRACE_HEADER*in

EVENT_TRACE_HEADER 構造体へのポインター。イベント固有のデータは、必要に応じて構造体の後に付加できます。 ログに記録できる最大のイベントは、64K をわずかに下回るサイズです。 EVENT_TRACE_HEADER 構造体の次のメンバーに値を指定する必要があります。

  • Size
  • Guid または GuidPtr
  • Flags

プロバイダーが提供する情報の複雑さに応じて、 次のメンバーにも値を指定することを検討してください。

  • Class.Type
  • Class.Level

戻り値の型: WIN32_ERROR

公式ドキュメント

RegisterTraceGuids ベース(「クラシック」)のイベントプロバイダーは、TraceEvent を使用します

戻り値

関数が成功した場合、戻り値は ERROR_SUCCESS です。

関数が失敗した場合、戻り値は システムエラーコード のいずれかです。 以下は、一般的なエラーとその原因です。

解説(Remarks)

MOF ベースの ETW プロバイダーがこの関数を呼び出します。

メモ

ほとんどの開発者はこの関数を呼び出しません。この API は MOF ベースの ETW をサポートしていますが、MOF ベースの ETW は非推奨であり、 マニフェストベースの ETW が推奨されます。さらに、ほとんどの MOF ベースの プロバイダーは、ETW API を直接呼び出す代わりに、MC.exe によって生成された ラッパー関数を使用します。

プロバイダーがこの関数を呼び出す前に、プロバイダーは次のことを行う必要があります。

イベントは、ログファイルに書き込まれるか、リアルタイムでイベントトレースコンシューマーに 送信されるか、またはその両方が行われます。StartTrace に渡される EVENT_TRACE_PROPERTIES 構造体の LogFileMode メンバーが、イベントの送信先を定義します。

トレースイベントは、発生した順序で書き込まれます。

関連する一連のイベントをトレースするには、 TraceEventInstance 関数を使用します。

Windows Vista では、イベントをログに記録するために EventWrite 関数を 使用してください。

Examples

TraceEvent を使用する例については、 Tracing Events を参照してください。

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

各言語での呼び出し定義

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

WIN32_ERROR TraceEvent(
    ULONGLONG TraceHandle,
    EVENT_TRACE_HEADER* EventTrace
);
[DllImport("ADVAPI32.dll", ExactSpelling = true)]
static extern uint TraceEvent(
    ulong TraceHandle,   // ULONGLONG
    IntPtr EventTrace   // EVENT_TRACE_HEADER*
);
<DllImport("ADVAPI32.dll", ExactSpelling:=True)>
Public Shared Function TraceEvent(
    TraceHandle As ULong,   ' ULONGLONG
    EventTrace As IntPtr   ' EVENT_TRACE_HEADER*
) As UInteger
End Function
' TraceHandle : ULONGLONG
' EventTrace : EVENT_TRACE_HEADER*
Declare PtrSafe Function TraceEvent Lib "advapi32" ( _
    ByVal TraceHandle As LongLong, _
    ByVal EventTrace As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

TraceEvent = ctypes.windll.advapi32.TraceEvent
TraceEvent.restype = wintypes.DWORD
TraceEvent.argtypes = [
    ctypes.c_ulonglong,  # TraceHandle : ULONGLONG
    ctypes.c_void_p,  # EventTrace : EVENT_TRACE_HEADER*
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ADVAPI32.dll')
TraceEvent = Fiddle::Function.new(
  lib['TraceEvent'],
  [
    -Fiddle::TYPE_LONG_LONG,  # TraceHandle : ULONGLONG
    Fiddle::TYPE_VOIDP,  # EventTrace : EVENT_TRACE_HEADER*
  ],
  -Fiddle::TYPE_INT)
#[link(name = "advapi32")]
extern "system" {
    fn TraceEvent(
        TraceHandle: u64,  // ULONGLONG
        EventTrace: *mut EVENT_TRACE_HEADER  // EVENT_TRACE_HEADER*
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("ADVAPI32.dll")]
public static extern uint TraceEvent(ulong TraceHandle, IntPtr EventTrace);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_TraceEvent' -Namespace Win32 -PassThru
# $api::TraceEvent(TraceHandle, EventTrace)
#uselib "ADVAPI32.dll"
#func global TraceEvent "TraceEvent" sptr, sptr
; TraceEvent TraceHandle, varptr(EventTrace)   ; 戻り値は stat
; TraceHandle : ULONGLONG -> "sptr"
; EventTrace : EVENT_TRACE_HEADER* -> "sptr"
; ※HSP3.7は int64 引数(64bit値渡し)に非対応です。
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "ADVAPI32.dll"
#cfunc global TraceEvent "TraceEvent" int64, var
; res = TraceEvent(TraceHandle, EventTrace)
; TraceHandle : ULONGLONG -> "int64"
; EventTrace : EVENT_TRACE_HEADER* -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
; ※int64 引数の DLL 値渡しは x64 ランタイム(hsp3_64)のみ対応(x86 は未対応)。
出力引数:
; WIN32_ERROR TraceEvent(ULONGLONG TraceHandle, EVENT_TRACE_HEADER* EventTrace)
#uselib "ADVAPI32.dll"
#cfunc global TraceEvent "TraceEvent" int64, var
; res = TraceEvent(TraceHandle, EventTrace)
; TraceHandle : ULONGLONG -> "int64"
; EventTrace : EVENT_TRACE_HEADER* -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	advapi32 = windows.NewLazySystemDLL("ADVAPI32.dll")
	procTraceEvent = advapi32.NewProc("TraceEvent")
)

// TraceHandle (ULONGLONG), EventTrace (EVENT_TRACE_HEADER*)
r1, _, err := procTraceEvent.Call(
	uintptr(TraceHandle),
	uintptr(EventTrace),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // WIN32_ERROR
function TraceEvent(
  TraceHandle: UInt64;   // ULONGLONG
  EventTrace: Pointer   // EVENT_TRACE_HEADER*
): DWORD; stdcall;
  external 'ADVAPI32.dll' name 'TraceEvent';
result := DllCall("ADVAPI32\TraceEvent"
    , "Int64", TraceHandle   ; ULONGLONG
    , "Ptr", EventTrace   ; EVENT_TRACE_HEADER*
    , "UInt")   ; return: WIN32_ERROR
●TraceEvent(TraceHandle, EventTrace) = DLL("ADVAPI32.dll", "dword TraceEvent(qword, void*)")
# 呼び出し: TraceEvent(TraceHandle, EventTrace)
# TraceHandle : ULONGLONG -> "qword"
# EventTrace : EVENT_TRACE_HEADER* -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "advapi32" fn TraceEvent(
    TraceHandle: u64, // ULONGLONG
    EventTrace: [*c]EVENT_TRACE_HEADER // EVENT_TRACE_HEADER*
) callconv(std.os.windows.WINAPI) u32;
proc TraceEvent(
    TraceHandle: uint64,  # ULONGLONG
    EventTrace: ptr EVENT_TRACE_HEADER  # EVENT_TRACE_HEADER*
): uint32 {.importc: "TraceEvent", stdcall, dynlib: "ADVAPI32.dll".}
pragma(lib, "advapi32");
extern(Windows)
uint TraceEvent(
    ulong TraceHandle,   // ULONGLONG
    EVENT_TRACE_HEADER* EventTrace   // EVENT_TRACE_HEADER*
);
ccall((:TraceEvent, "ADVAPI32.dll"), stdcall, UInt32,
      (UInt64, Ptr{EVENT_TRACE_HEADER}),
      TraceHandle, EventTrace)
# TraceHandle : ULONGLONG -> UInt64
# EventTrace : EVENT_TRACE_HEADER* -> Ptr{EVENT_TRACE_HEADER}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t TraceEvent(
    uint64_t TraceHandle,
    void* EventTrace);
]]
local advapi32 = ffi.load("advapi32")
-- advapi32.TraceEvent(TraceHandle, EventTrace)
-- TraceHandle : ULONGLONG
-- EventTrace : EVENT_TRACE_HEADER*
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('ADVAPI32.dll');
const TraceEvent = lib.func('__stdcall', 'TraceEvent', 'uint32_t', ['uint64_t', 'void *']);
// TraceEvent(TraceHandle, EventTrace)
// TraceHandle : ULONGLONG -> 'uint64_t'
// EventTrace : EVENT_TRACE_HEADER* -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("ADVAPI32.dll", {
  TraceEvent: { parameters: ["u64", "pointer"], result: "u32" },
});
// lib.symbols.TraceEvent(TraceHandle, EventTrace)
// TraceHandle : ULONGLONG -> "u64"
// EventTrace : EVENT_TRACE_HEADER* -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t TraceEvent(
    uint64_t TraceHandle,
    void* EventTrace);
C, "ADVAPI32.dll");
// $ffi->TraceEvent(TraceHandle, EventTrace);
// TraceHandle : ULONGLONG
// EventTrace : EVENT_TRACE_HEADER*
// 構造体/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 TraceEvent(
        long TraceHandle,   // ULONGLONG
        Pointer EventTrace   // EVENT_TRACE_HEADER*
    );
}
@[Link("advapi32")]
lib LibADVAPI32
  fun TraceEvent = TraceEvent(
    TraceHandle : UInt64,   # ULONGLONG
    EventTrace : EVENT_TRACE_HEADER*   # EVENT_TRACE_HEADER*
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef TraceEventNative = Uint32 Function(Uint64, Pointer<Void>);
typedef TraceEventDart = int Function(int, Pointer<Void>);
final TraceEvent = DynamicLibrary.open('ADVAPI32.dll')
    .lookupFunction<TraceEventNative, TraceEventDart>('TraceEvent');
// TraceHandle : ULONGLONG -> Uint64
// EventTrace : EVENT_TRACE_HEADER* -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function TraceEvent(
  TraceHandle: UInt64;   // ULONGLONG
  EventTrace: Pointer   // EVENT_TRACE_HEADER*
): DWORD; stdcall;
  external 'ADVAPI32.dll' name 'TraceEvent';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "TraceEvent"
  c_TraceEvent :: Word64 -> Ptr () -> IO Word32
-- TraceHandle : ULONGLONG -> Word64
-- EventTrace : EVENT_TRACE_HEADER* -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let traceevent =
  foreign "TraceEvent"
    (uint64_t @-> (ptr void) @-> returning uint32_t)
(* TraceHandle : ULONGLONG -> uint64_t *)
(* EventTrace : EVENT_TRACE_HEADER* -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library advapi32 (t "ADVAPI32.dll"))
(cffi:use-foreign-library advapi32)

(cffi:defcfun ("TraceEvent" trace-event :convention :stdcall) :uint32
  (trace-handle :uint64)   ; ULONGLONG
  (event-trace :pointer))   ; EVENT_TRACE_HEADER*
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $TraceEvent = Win32::API::More->new('ADVAPI32',
    'DWORD TraceEvent(UINT64 TraceHandle, LPVOID EventTrace)');
# my $ret = $TraceEvent->Call($TraceHandle, $EventTrace);
# TraceHandle : ULONGLONG -> UINT64
# EventTrace : EVENT_TRACE_HEADER* -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型