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

StartTraceA

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

シグネチャ

// ADVAPI32.dll  (ANSI / -A)
#include <windows.h>

WIN32_ERROR StartTraceA(
    ULONGLONG* TraceId,
    LPCSTR InstanceName,
    EVENT_TRACE_PROPERTIES* Properties
);

パラメーター

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

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

重要

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

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

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 関数はイベント トレース セッションを開始します。(ANSI)

戻り値

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

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

解説(Remarks)

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

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

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

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

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

システム ロガー

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

メモ

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

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

NT Kernel Logger セッション (非推奨) を指定するには、InstanceNameKERNEL_LOGGER_NAME に、PropertiesWnode.Guid メンバーを SystemTraceControlGuid に設定します。GUID を SystemTraceControlGuid として指定しない場合、ETW は GUID 値を上書きして SystemTraceControlGuid に設定します。

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

メモ

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

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

各言語での呼び出し定義

// ADVAPI32.dll  (ANSI / -A)
#include <windows.h>

WIN32_ERROR StartTraceA(
    ULONGLONG* TraceId,
    LPCSTR InstanceName,
    EVENT_TRACE_PROPERTIES* Properties
);
[DllImport("ADVAPI32.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint StartTraceA(
    out ulong TraceId,   // ULONGLONG* out
    [MarshalAs(UnmanagedType.LPStr)] string InstanceName,   // LPCSTR
    IntPtr Properties   // EVENT_TRACE_PROPERTIES* in/out
);
<DllImport("ADVAPI32.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function StartTraceA(
    <Out> ByRef TraceId As ULong,   ' ULONGLONG* out
    <MarshalAs(UnmanagedType.LPStr)> InstanceName As String,   ' LPCSTR
    Properties As IntPtr   ' EVENT_TRACE_PROPERTIES* in/out
) As UInteger
End Function
' TraceId : ULONGLONG* out
' InstanceName : LPCSTR
' Properties : EVENT_TRACE_PROPERTIES* in/out
Declare PtrSafe Function StartTraceA Lib "advapi32" ( _
    ByRef TraceId As LongLong, _
    ByVal InstanceName As String, _
    ByVal Properties As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

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

lib = Fiddle.dlopen('ADVAPI32.dll')
StartTraceA = Fiddle::Function.new(
  lib['StartTraceA'],
  [
    Fiddle::TYPE_VOIDP,  # TraceId : ULONGLONG* out
    Fiddle::TYPE_VOIDP,  # InstanceName : LPCSTR
    Fiddle::TYPE_VOIDP,  # Properties : EVENT_TRACE_PROPERTIES* in/out
  ],
  -Fiddle::TYPE_INT)
#[link(name = "advapi32")]
extern "system" {
    fn StartTraceA(
        TraceId: *mut u64,  // ULONGLONG* out
        InstanceName: *const u8,  // LPCSTR
        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.Ansi)]
public static extern uint StartTraceA(out ulong TraceId, [MarshalAs(UnmanagedType.LPStr)] string InstanceName, IntPtr Properties);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_StartTraceA' -Namespace Win32 -PassThru
# $api::StartTraceA(TraceId, InstanceName, Properties)
#uselib "ADVAPI32.dll"
#func global StartTraceA "StartTraceA" sptr, sptr, sptr
; StartTraceA varptr(TraceId), InstanceName, varptr(Properties)   ; 戻り値は stat
; TraceId : ULONGLONG* out -> "sptr"
; InstanceName : LPCSTR -> "sptr"
; Properties : EVENT_TRACE_PROPERTIES* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "ADVAPI32.dll"
#cfunc global StartTraceA "StartTraceA" var, str, var
; res = StartTraceA(TraceId, InstanceName, Properties)
; TraceId : ULONGLONG* out -> "var"
; InstanceName : LPCSTR -> "str"
; Properties : EVENT_TRACE_PROPERTIES* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; WIN32_ERROR StartTraceA(ULONGLONG* TraceId, LPCSTR InstanceName, EVENT_TRACE_PROPERTIES* Properties)
#uselib "ADVAPI32.dll"
#cfunc global StartTraceA "StartTraceA" var, str, var
; res = StartTraceA(TraceId, InstanceName, Properties)
; TraceId : ULONGLONG* out -> "var"
; InstanceName : LPCSTR -> "str"
; Properties : EVENT_TRACE_PROPERTIES* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	advapi32 = windows.NewLazySystemDLL("ADVAPI32.dll")
	procStartTraceA = advapi32.NewProc("StartTraceA")
)

// TraceId (ULONGLONG* out), InstanceName (LPCSTR), Properties (EVENT_TRACE_PROPERTIES* in/out)
r1, _, err := procStartTraceA.Call(
	uintptr(TraceId),
	uintptr(unsafe.Pointer(windows.BytePtrFromString(InstanceName))),
	uintptr(Properties),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // WIN32_ERROR
function StartTraceA(
  TraceId: Pointer;   // ULONGLONG* out
  InstanceName: PAnsiChar;   // LPCSTR
  Properties: Pointer   // EVENT_TRACE_PROPERTIES* in/out
): DWORD; stdcall;
  external 'ADVAPI32.dll' name 'StartTraceA';
result := DllCall("ADVAPI32\StartTraceA"
    , "Ptr", TraceId   ; ULONGLONG* out
    , "AStr", InstanceName   ; LPCSTR
    , "Ptr", Properties   ; EVENT_TRACE_PROPERTIES* in/out
    , "UInt")   ; return: WIN32_ERROR
●StartTraceA(TraceId, InstanceName, Properties) = DLL("ADVAPI32.dll", "dword StartTraceA(void*, char*, void*)")
# 呼び出し: StartTraceA(TraceId, InstanceName, Properties)
# TraceId : ULONGLONG* out -> "void*"
# InstanceName : LPCSTR -> "char*"
# Properties : EVENT_TRACE_PROPERTIES* in/out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "advapi32" fn StartTraceA(
    TraceId: [*c]u64, // ULONGLONG* out
    InstanceName: [*c]const u8, // LPCSTR
    Properties: [*c]EVENT_TRACE_PROPERTIES // EVENT_TRACE_PROPERTIES* in/out
) callconv(std.os.windows.WINAPI) u32;
proc StartTraceA(
    TraceId: ptr uint64,  # ULONGLONG* out
    InstanceName: cstring,  # LPCSTR
    Properties: ptr EVENT_TRACE_PROPERTIES  # EVENT_TRACE_PROPERTIES* in/out
): uint32 {.importc: "StartTraceA", stdcall, dynlib: "ADVAPI32.dll".}
pragma(lib, "advapi32");
extern(Windows)
uint StartTraceA(
    ulong* TraceId,   // ULONGLONG* out
    const(char)* InstanceName,   // LPCSTR
    EVENT_TRACE_PROPERTIES* Properties   // EVENT_TRACE_PROPERTIES* in/out
);
ccall((:StartTraceA, "ADVAPI32.dll"), stdcall, UInt32,
      (Ptr{UInt64}, Cstring, Ptr{EVENT_TRACE_PROPERTIES}),
      TraceId, InstanceName, Properties)
# TraceId : ULONGLONG* out -> Ptr{UInt64}
# InstanceName : LPCSTR -> Cstring
# Properties : EVENT_TRACE_PROPERTIES* in/out -> Ptr{EVENT_TRACE_PROPERTIES}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t StartTraceA(
    uint64_t* TraceId,
    const char* InstanceName,
    void* Properties);
]]
local advapi32 = ffi.load("advapi32")
-- advapi32.StartTraceA(TraceId, InstanceName, Properties)
-- TraceId : ULONGLONG* out
-- InstanceName : LPCSTR
-- Properties : EVENT_TRACE_PROPERTIES* in/out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('ADVAPI32.dll');
const StartTraceA = lib.func('__stdcall', 'StartTraceA', 'uint32_t', ['uint64_t *', 'str', 'void *']);
// StartTraceA(TraceId, InstanceName, Properties)
// TraceId : ULONGLONG* out -> 'uint64_t *'
// InstanceName : LPCSTR -> 'str'
// Properties : EVENT_TRACE_PROPERTIES* in/out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("ADVAPI32.dll", {
  StartTraceA: { parameters: ["pointer", "buffer", "pointer"], result: "u32" },
});
// lib.symbols.StartTraceA(TraceId, InstanceName, Properties)
// TraceId : ULONGLONG* out -> "pointer"
// InstanceName : LPCSTR -> "buffer"
// Properties : EVENT_TRACE_PROPERTIES* in/out -> "pointer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t StartTraceA(
    uint64_t* TraceId,
    const char* InstanceName,
    void* Properties);
C, "ADVAPI32.dll");
// $ffi->StartTraceA(TraceId, InstanceName, Properties);
// TraceId : ULONGLONG* out
// InstanceName : LPCSTR
// 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.ASCII_OPTIONS);
    int StartTraceA(
        LongByReference TraceId,   // ULONGLONG* out
        String InstanceName,   // LPCSTR
        Pointer Properties   // EVENT_TRACE_PROPERTIES* in/out
    );
}
@[Link("advapi32")]
lib LibADVAPI32
  fun StartTraceA = StartTraceA(
    TraceId : UInt64*,   # ULONGLONG* out
    InstanceName : UInt8*,   # LPCSTR
    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 StartTraceANative = Uint32 Function(Pointer<Uint64>, Pointer<Utf8>, Pointer<Void>);
typedef StartTraceADart = int Function(Pointer<Uint64>, Pointer<Utf8>, Pointer<Void>);
final StartTraceA = DynamicLibrary.open('ADVAPI32.dll')
    .lookupFunction<StartTraceANative, StartTraceADart>('StartTraceA');
// TraceId : ULONGLONG* out -> Pointer<Uint64>
// InstanceName : LPCSTR -> Pointer<Utf8>
// Properties : EVENT_TRACE_PROPERTIES* in/out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function StartTraceA(
  TraceId: Pointer;   // ULONGLONG* out
  InstanceName: PAnsiChar;   // LPCSTR
  Properties: Pointer   // EVENT_TRACE_PROPERTIES* in/out
): DWORD; stdcall;
  external 'ADVAPI32.dll' name 'StartTraceA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let starttracea =
  foreign "StartTraceA"
    ((ptr uint64_t) @-> string @-> (ptr void) @-> returning uint32_t)
(* TraceId : ULONGLONG* out -> (ptr uint64_t) *)
(* InstanceName : LPCSTR -> string *)
(* 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 ("StartTraceA" start-trace-a :convention :stdcall) :uint32
  (trace-id :pointer)   ; ULONGLONG* out
  (instance-name :string)   ; LPCSTR
  (properties :pointer))   ; EVENT_TRACE_PROPERTIES* in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $StartTraceA = Win32::API::More->new('ADVAPI32',
    'DWORD StartTraceA(LPVOID TraceId, LPCSTR InstanceName, LPVOID Properties)');
# my $ret = $StartTraceA->Call($TraceId, $InstanceName, $Properties);
# TraceId : ULONGLONG* out -> LPVOID
# InstanceName : LPCSTR -> LPCSTR
# Properties : EVENT_TRACE_PROPERTIES* in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

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