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

StartTraceW

関数
指定したプロパティでイベントトレースセッションを開始する(Unicode版)。
DLLADVAPI32.dll文字セットUnicode (-W)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

// ADVAPI32.dll  (Unicode / -W)
#include <windows.h>

WIN32_ERROR StartTraceW(
    ULONGLONG* TraceId,
    LPCWSTR InstanceName,
    EVENT_TRACE_PROPERTIES* Properties
);

パラメーター

名前型方向説明
TraceIdULONGLONG*out開始したトレースセッションのハンドルを受け取る出力ポインタ。
InstanceNameLPCWSTRin

イベントトレースセッションの名前を含む、null 終端文字列です。セッション名は 1,024 文字以内で、大文字と小文字を区別せず、一意である必要があります。

重要

セッション名からその所有者と用途を判別できるよう、わかりやすい名前を使用してください。GUID やその他の非決定的または非記述的な値は使用しないでください。セッション名を一意にするためにランダムな数字を付加しないでください。ETW セッションは限られたリソースであるため、コンポーネントが複数のセッションを開始するべきではありません。コンポーネントの開始時にそのセッションが既に実行中である場合は、2 つ目のセッションを作成するのではなく、孤立したセッションをクリーンアップしてください。

この関数は、指定したセッション名を Properties の LoggerNameOffset メンバーが指すオフセットへコピーします。

PropertiesEVENT_TRACE_PROPERTIES*inout

セッションの動作を指定する EVENT_TRACE_PROPERTIES 構造体へのポインターです。設定すべき主要なメンバーは次のとおりです。

  • Wnode.BufferSize
  • Wnode.Guid
  • Wnode.ClientContext
  • Wnode.Flags
  • LogFileMode
  • LogFileNameOffset
  • LoggerNameOffset

作成するログファイルの種類によっては、MaximumFileSize の値も指定する必要があります。Properties パラメーターの設定方法やセッションの動作の詳細については、「解説」セクションを参照してください。

Windows 10 バージョン 1703 以降: プロセス間シナリオでのパフォーマンス向上のため、システム全体のプライベートロガーを開始する際に、StartTrace へフィルター処理を渡せるようになりました。フィルター情報を含めるには、新しい EVENT_TRACE_PROPERTIES_V2 構造体を渡す必要があります。詳細については Configuring and Starting a Private Logger Session を参照してください。

戻り値の型: WIN32_ERROR

公式ドキュメント

StartTrace 関数はイベントトレースセッションを開始します。(Unicode)

戻り値

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

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

解説(Remarks)

イベントトレースコントローラーがこの関数を呼び出します。

セッションは、停止されるか、コンピューターが再起動されるか、I/O エラーが発生するか、非循環ログで最大ファイルサイズに達するまでアクティブな状態を維持します。イベントトレースセッションを停止するには、ControlTrace 関数を呼び出し、ControlCode パラメーターを EVENT_TRACE_CONTROL_STOP に設定します。

同じセッション GUID (Properties.Wnode.Guid で指定) で複数のセッションを開始することはできません。ほとんどの場合、Properties.Wnode.Guid をすべてゼロ (すなわち GUID_NULL) に設定して、ETW システムがセッション用の新しい GUID を生成できるようにします。

プライベートロガーセッションを指定するには、Properties の Wnode.Guid メンバーを、プライベートロガーセッションの制御 GUID ではなく、プロバイダーの制御 GUID に設定します。StartTrace を呼び出す前に、プロバイダーがその GUID を登録しておく必要があります。

この関数は、グローバルロガーセッション (非推奨) の開始には使用しません。グローバルロガーセッションの開始の詳細については、Configuring and Starting the Global Logger Session を参照してください。

システムロガー

ロガーがシステムロガーとなり、SystemTraceProvider やその他の システムプロバイダー からイベントを受信するには、次のいずれかが満たされている必要があります。

メモ

システムロガーは、トレースに含める SystemTraceProvider イベントを示すために、EVENT_TRACE_PROPERTIES 構造体の EnableFlags メンバーを設定する必要があります。

システムロガーは特別なカーネルイベントを受信するため、次の追加の制約を受けます。

NT Kernel Logger セッション (非推奨) を指定するには、InstanceName を KERNEL_LOGGER_NAME に、Properties の Wnode.Guid メンバーを SystemTraceControlGuid に設定します。GUID を SystemTraceControlGuid として指定しなかった場合、ETW は GUID 値を上書きして SystemTraceControlGuid に設定します。

例

StartTrace を使用する例については、Configuring and Starting an Event Tracing Session を参照してください。

メモ

evntrace.h ヘッダーは StartTrace をエイリアスとして定義しており、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択します。エンコーディング中立のエイリアスの使用を、エンコーディング中立でないコードと混在させると、コンパイルエラーや実行時エラーを引き起こす不整合につながる可能性があります。詳細については Conventions for Function Prototypes を参照してください。

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

各言語での呼び出し定義

// ADVAPI32.dll  (Unicode / -W)
#include <windows.h>

WIN32_ERROR StartTraceW(
    ULONGLONG* TraceId,
    LPCWSTR InstanceName,
    EVENT_TRACE_PROPERTIES* Properties
);
[DllImport("ADVAPI32.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern uint StartTraceW(
    out ulong TraceId,   // ULONGLONG* out
    [MarshalAs(UnmanagedType.LPWStr)] string InstanceName,   // LPCWSTR
    IntPtr Properties   // EVENT_TRACE_PROPERTIES* in/out
);
<DllImport("ADVAPI32.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function StartTraceW(
    <Out> ByRef TraceId As ULong,   ' ULONGLONG* out
    <MarshalAs(UnmanagedType.LPWStr)> InstanceName As String,   ' LPCWSTR
    Properties As IntPtr   ' EVENT_TRACE_PROPERTIES* in/out
) As UInteger
End Function
' TraceId : ULONGLONG* out
' InstanceName : LPCWSTR
' Properties : EVENT_TRACE_PROPERTIES* in/out
Declare PtrSafe Function StartTraceW Lib "advapi32" ( _
    ByRef TraceId As LongLong, _
    ByVal InstanceName As LongPtr, _
    ByVal Properties As LongPtr) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

StartTraceW = ctypes.windll.advapi32.StartTraceW
StartTraceW.restype = wintypes.DWORD
StartTraceW.argtypes = [
    ctypes.POINTER(ctypes.c_ulonglong),  # TraceId : ULONGLONG* out
    wintypes.LPCWSTR,  # InstanceName : LPCWSTR
    ctypes.c_void_p,  # Properties : EVENT_TRACE_PROPERTIES* in/out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ADVAPI32.dll')
StartTraceW = Fiddle::Function.new(
  lib['StartTraceW'],
  [
    Fiddle::TYPE_VOIDP,  # TraceId : ULONGLONG* out
    Fiddle::TYPE_VOIDP,  # InstanceName : LPCWSTR
    Fiddle::TYPE_VOIDP,  # Properties : EVENT_TRACE_PROPERTIES* in/out
  ],
  -Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "advapi32")]
extern "system" {
    fn StartTraceW(
        TraceId: *mut u64,  // ULONGLONG* out
        InstanceName: *const u16,  // LPCWSTR
        Properties: *mut EVENT_TRACE_PROPERTIES  // EVENT_TRACE_PROPERTIES* in/out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("ADVAPI32.dll", CharSet = CharSet.Unicode)]
public static extern uint StartTraceW(out ulong TraceId, [MarshalAs(UnmanagedType.LPWStr)] string InstanceName, IntPtr Properties);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_StartTraceW' -Namespace Win32 -PassThru
# $api::StartTraceW(TraceId, InstanceName, Properties)
#uselib "ADVAPI32.dll"
#func global StartTraceW "StartTraceW" wptr, wptr, wptr
; StartTraceW varptr(TraceId), InstanceName, varptr(Properties)   ; 戻り値は stat
; TraceId : ULONGLONG* out -> "wptr"
; InstanceName : LPCWSTR -> "wptr"
; Properties : EVENT_TRACE_PROPERTIES* in/out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "ADVAPI32.dll"
#cfunc global StartTraceW "StartTraceW" var, wstr, var
; res = StartTraceW(TraceId, InstanceName, Properties)
; TraceId : ULONGLONG* out -> "var"
; InstanceName : LPCWSTR -> "wstr"
; Properties : EVENT_TRACE_PROPERTIES* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; WIN32_ERROR StartTraceW(ULONGLONG* TraceId, LPCWSTR InstanceName, EVENT_TRACE_PROPERTIES* Properties)
#uselib "ADVAPI32.dll"
#cfunc global StartTraceW "StartTraceW" var, wstr, var
; res = StartTraceW(TraceId, InstanceName, Properties)
; TraceId : ULONGLONG* out -> "var"
; InstanceName : LPCWSTR -> "wstr"
; Properties : EVENT_TRACE_PROPERTIES* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	advapi32 = windows.NewLazySystemDLL("ADVAPI32.dll")
	procStartTraceW = advapi32.NewProc("StartTraceW")
)

// TraceId (ULONGLONG* out), InstanceName (LPCWSTR), Properties (EVENT_TRACE_PROPERTIES* in/out)
r1, _, err := procStartTraceW.Call(
	uintptr(TraceId),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(InstanceName))),
	uintptr(Properties),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // WIN32_ERROR
function StartTraceW(
  TraceId: Pointer;   // ULONGLONG* out
  InstanceName: PWideChar;   // LPCWSTR
  Properties: Pointer   // EVENT_TRACE_PROPERTIES* in/out
): DWORD; stdcall;
  external 'ADVAPI32.dll' name 'StartTraceW';
result := DllCall("ADVAPI32\StartTraceW"
    , "Ptr", TraceId   ; ULONGLONG* out
    , "WStr", InstanceName   ; LPCWSTR
    , "Ptr", Properties   ; EVENT_TRACE_PROPERTIES* in/out
    , "UInt")   ; return: WIN32_ERROR
●StartTraceW(TraceId, InstanceName, Properties) = DLL("ADVAPI32.dll", "dword StartTraceW(void*, char*, void*)")
# 呼び出し: StartTraceW(TraceId, InstanceName, Properties)
# TraceId : ULONGLONG* out -> "void*"
# InstanceName : LPCWSTR -> "char*"
# Properties : EVENT_TRACE_PROPERTIES* in/out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "advapi32" fn StartTraceW(
    TraceId: [*c]u64, // ULONGLONG* out
    InstanceName: [*c]const u16, // LPCWSTR
    Properties: [*c]EVENT_TRACE_PROPERTIES // EVENT_TRACE_PROPERTIES* in/out
) callconv(std.os.windows.WINAPI) u32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc StartTraceW(
    TraceId: ptr uint64,  # ULONGLONG* out
    InstanceName: WideCString,  # LPCWSTR
    Properties: ptr EVENT_TRACE_PROPERTIES  # EVENT_TRACE_PROPERTIES* in/out
): uint32 {.importc: "StartTraceW", stdcall, dynlib: "ADVAPI32.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "advapi32");
extern(Windows)
uint StartTraceW(
    ulong* TraceId,   // ULONGLONG* out
    const(wchar)* InstanceName,   // LPCWSTR
    EVENT_TRACE_PROPERTIES* Properties   // EVENT_TRACE_PROPERTIES* in/out
);
ccall((:StartTraceW, "ADVAPI32.dll"), stdcall, UInt32,
      (Ptr{UInt64}, Cwstring, Ptr{EVENT_TRACE_PROPERTIES}),
      TraceId, InstanceName, Properties)
# TraceId : ULONGLONG* out -> Ptr{UInt64}
# InstanceName : LPCWSTR -> Cwstring
# Properties : EVENT_TRACE_PROPERTIES* in/out -> Ptr{EVENT_TRACE_PROPERTIES}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
uint32_t StartTraceW(
    uint64_t* TraceId,
    const uint16_t* InstanceName,
    void* Properties);
]]
local advapi32 = ffi.load("advapi32")
-- advapi32.StartTraceW(TraceId, InstanceName, Properties)
-- TraceId : ULONGLONG* out
-- InstanceName : LPCWSTR
-- Properties : EVENT_TRACE_PROPERTIES* in/out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('ADVAPI32.dll');
const StartTraceW = lib.func('__stdcall', 'StartTraceW', 'uint32_t', ['uint64_t *', 'str16', 'void *']);
// StartTraceW(TraceId, InstanceName, Properties)
// TraceId : ULONGLONG* out -> 'uint64_t *'
// InstanceName : LPCWSTR -> 'str16'
// Properties : EVENT_TRACE_PROPERTIES* in/out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("ADVAPI32.dll", {
  StartTraceW: { parameters: ["pointer", "buffer", "pointer"], result: "u32" },
});
// lib.symbols.StartTraceW(TraceId, InstanceName, Properties)
// TraceId : ULONGLONG* out -> "pointer"
// InstanceName : LPCWSTR -> "buffer"
// Properties : EVENT_TRACE_PROPERTIES* in/out -> "pointer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t StartTraceW(
    uint64_t* TraceId,
    const uint16_t* InstanceName,
    void* Properties);
C, "ADVAPI32.dll");
// $ffi->StartTraceW(TraceId, InstanceName, Properties);
// TraceId : ULONGLONG* out
// InstanceName : LPCWSTR
// Properties : EVENT_TRACE_PROPERTIES* in/out
// 構造体/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, W32APIOptions.UNICODE_OPTIONS);
    int StartTraceW(
        LongByReference TraceId,   // ULONGLONG* out
        WString InstanceName,   // LPCWSTR
        Pointer Properties   // EVENT_TRACE_PROPERTIES* in/out
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("advapi32")]
lib LibADVAPI32
  fun StartTraceW = StartTraceW(
    TraceId : UInt64*,   # ULONGLONG* out
    InstanceName : UInt16*,   # LPCWSTR
    Properties : EVENT_TRACE_PROPERTIES*   # EVENT_TRACE_PROPERTIES* in/out
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef StartTraceWNative = Uint32 Function(Pointer<Uint64>, Pointer<Utf16>, Pointer<Void>);
typedef StartTraceWDart = int Function(Pointer<Uint64>, Pointer<Utf16>, Pointer<Void>);
final StartTraceW = DynamicLibrary.open('ADVAPI32.dll')
    .lookupFunction<StartTraceWNative, StartTraceWDart>('StartTraceW');
// TraceId : ULONGLONG* out -> Pointer<Uint64>
// InstanceName : LPCWSTR -> Pointer<Utf16>
// Properties : EVENT_TRACE_PROPERTIES* in/out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function StartTraceW(
  TraceId: Pointer;   // ULONGLONG* out
  InstanceName: PWideChar;   // LPCWSTR
  Properties: Pointer   // EVENT_TRACE_PROPERTIES* in/out
): DWORD; stdcall;
  external 'ADVAPI32.dll' name 'StartTraceW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "StartTraceW"
  c_StartTraceW :: Ptr Word64 -> CWString -> Ptr () -> IO Word32
-- TraceId : ULONGLONG* out -> Ptr Word64
-- InstanceName : LPCWSTR -> CWString
-- Properties : EVENT_TRACE_PROPERTIES* in/out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let starttracew =
  foreign "StartTraceW"
    ((ptr uint64_t) @-> (ptr uint16_t) @-> (ptr void) @-> returning uint32_t)
(* TraceId : ULONGLONG* out -> (ptr uint64_t) *)
(* InstanceName : LPCWSTR -> (ptr uint16_t) *)
(* Properties : EVENT_TRACE_PROPERTIES* in/out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library advapi32 (t "ADVAPI32.dll"))
(cffi:use-foreign-library advapi32)

(cffi:defcfun ("StartTraceW" start-trace-w :convention :stdcall) :uint32
  (trace-id :pointer)   ; ULONGLONG* out
  (instance-name (:string :encoding :utf-16le))   ; LPCWSTR
  (properties :pointer))   ; EVENT_TRACE_PROPERTIES* in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $StartTraceW = Win32::API::More->new('ADVAPI32',
    'DWORD StartTraceW(LPVOID TraceId, LPCWSTR InstanceName, LPVOID Properties)');
# my $ret = $StartTraceW->Call($TraceId, $InstanceName, $Properties);
# TraceId : ULONGLONG* out -> LPVOID
# InstanceName : LPCWSTR -> LPCWSTR
# Properties : EVENT_TRACE_PROPERTIES* in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い
使用する型