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

OpenTraceFromFile

関数
ETLログファイルからトレースを消費用に開く。
DLLADVAPI32.dll呼出規約winapi

シグネチャ

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

PROCESSTRACE_HANDLE OpenTraceFromFile(
    LPCWSTR LogFileName,
    const ETW_OPEN_TRACE_OPTIONS* Options,
    TRACE_LOGFILE_HEADER* LogFileHeader   // optional
);

パラメーター

名前方向説明
LogFileNameLPCWSTRin処理対象となる Tracelog の .etl ファイルのパス。
OptionsETW_OPEN_TRACE_OPTIONS*inこの処理セッションの構成オプション。詳細については ETW_OPEN_TRACE_OPTIONS を参照してください。
LogFileHeaderTRACE_LOGFILE_HEADER*outoptionalログファイルのヘッダー情報。詳細については TRACE_LOGFILE_HEADER を参照してください。

戻り値の型: PROCESSTRACE_HANDLE

公式ドキュメント

Tracelog の .etl ファイルを処理するためのトレース処理セッションを作成します。

戻り値

この処理セッションを識別するために使用される TRACEHANDLE。通常、処理を開始するために ProcessTrace に渡され、処理を終了するために CloseTrace に渡されます。

解説(Remarks)

返された TRACEHANDLE に対して ProcessTrace が呼び出されると、直ちにファイルの処理が開始され、Options で指定されたコールバックが呼び出されます。

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

各言語での呼び出し定義

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

PROCESSTRACE_HANDLE OpenTraceFromFile(
    LPCWSTR LogFileName,
    const ETW_OPEN_TRACE_OPTIONS* Options,
    TRACE_LOGFILE_HEADER* LogFileHeader   // optional
);
[DllImport("ADVAPI32.dll", ExactSpelling = true)]
static extern PROCESSTRACE_HANDLE OpenTraceFromFile(
    [MarshalAs(UnmanagedType.LPWStr)] string LogFileName,   // LPCWSTR
    IntPtr Options,   // ETW_OPEN_TRACE_OPTIONS*
    IntPtr LogFileHeader   // TRACE_LOGFILE_HEADER* optional, out
);
<DllImport("ADVAPI32.dll", ExactSpelling:=True)>
Public Shared Function OpenTraceFromFile(
    <MarshalAs(UnmanagedType.LPWStr)> LogFileName As String,   ' LPCWSTR
    Options As IntPtr,   ' ETW_OPEN_TRACE_OPTIONS*
    LogFileHeader As IntPtr   ' TRACE_LOGFILE_HEADER* optional, out
) As PROCESSTRACE_HANDLE
End Function
' LogFileName : LPCWSTR
' Options : ETW_OPEN_TRACE_OPTIONS*
' LogFileHeader : TRACE_LOGFILE_HEADER* optional, out
Declare PtrSafe Function OpenTraceFromFile Lib "advapi32" ( _
    ByVal LogFileName As LongPtr, _
    ByVal Options As LongPtr, _
    ByVal LogFileHeader As LongPtr) As LongPtr
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

OpenTraceFromFile = ctypes.windll.advapi32.OpenTraceFromFile
OpenTraceFromFile.restype = ctypes.c_void_p
OpenTraceFromFile.argtypes = [
    wintypes.LPCWSTR,  # LogFileName : LPCWSTR
    ctypes.c_void_p,  # Options : ETW_OPEN_TRACE_OPTIONS*
    ctypes.c_void_p,  # LogFileHeader : TRACE_LOGFILE_HEADER* optional, out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ADVAPI32.dll')
OpenTraceFromFile = Fiddle::Function.new(
  lib['OpenTraceFromFile'],
  [
    Fiddle::TYPE_VOIDP,  # LogFileName : LPCWSTR
    Fiddle::TYPE_VOIDP,  # Options : ETW_OPEN_TRACE_OPTIONS*
    Fiddle::TYPE_VOIDP,  # LogFileHeader : TRACE_LOGFILE_HEADER* optional, out
  ],
  Fiddle::TYPE_VOIDP)
#[link(name = "advapi32")]
extern "system" {
    fn OpenTraceFromFile(
        LogFileName: *const u16,  // LPCWSTR
        Options: *const ETW_OPEN_TRACE_OPTIONS,  // ETW_OPEN_TRACE_OPTIONS*
        LogFileHeader: *mut TRACE_LOGFILE_HEADER  // TRACE_LOGFILE_HEADER* optional, out
    ) -> PROCESSTRACE_HANDLE;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("ADVAPI32.dll")]
public static extern PROCESSTRACE_HANDLE OpenTraceFromFile([MarshalAs(UnmanagedType.LPWStr)] string LogFileName, IntPtr Options, IntPtr LogFileHeader);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_OpenTraceFromFile' -Namespace Win32 -PassThru
# $api::OpenTraceFromFile(LogFileName, Options, LogFileHeader)
#uselib "ADVAPI32.dll"
#func global OpenTraceFromFile "OpenTraceFromFile" sptr, sptr, sptr
; OpenTraceFromFile LogFileName, varptr(Options), varptr(LogFileHeader)   ; 戻り値は stat
; LogFileName : LPCWSTR -> "sptr"
; Options : ETW_OPEN_TRACE_OPTIONS* -> "sptr"
; LogFileHeader : TRACE_LOGFILE_HEADER* optional, out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "ADVAPI32.dll"
#cfunc global OpenTraceFromFile "OpenTraceFromFile" wstr, var, var
; res = OpenTraceFromFile(LogFileName, Options, LogFileHeader)
; LogFileName : LPCWSTR -> "wstr"
; Options : ETW_OPEN_TRACE_OPTIONS* -> "var"
; LogFileHeader : TRACE_LOGFILE_HEADER* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; PROCESSTRACE_HANDLE OpenTraceFromFile(LPCWSTR LogFileName, ETW_OPEN_TRACE_OPTIONS* Options, TRACE_LOGFILE_HEADER* LogFileHeader)
#uselib "ADVAPI32.dll"
#cfunc global OpenTraceFromFile "OpenTraceFromFile" wstr, var, var
; res = OpenTraceFromFile(LogFileName, Options, LogFileHeader)
; LogFileName : LPCWSTR -> "wstr"
; Options : ETW_OPEN_TRACE_OPTIONS* -> "var"
; LogFileHeader : TRACE_LOGFILE_HEADER* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	advapi32 = windows.NewLazySystemDLL("ADVAPI32.dll")
	procOpenTraceFromFile = advapi32.NewProc("OpenTraceFromFile")
)

// LogFileName (LPCWSTR), Options (ETW_OPEN_TRACE_OPTIONS*), LogFileHeader (TRACE_LOGFILE_HEADER* optional, out)
r1, _, err := procOpenTraceFromFile.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(LogFileName))),
	uintptr(Options),
	uintptr(LogFileHeader),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // PROCESSTRACE_HANDLE
function OpenTraceFromFile(
  LogFileName: PWideChar;   // LPCWSTR
  Options: Pointer;   // ETW_OPEN_TRACE_OPTIONS*
  LogFileHeader: Pointer   // TRACE_LOGFILE_HEADER* optional, out
): PROCESSTRACE_HANDLE; stdcall;
  external 'ADVAPI32.dll' name 'OpenTraceFromFile';
result := DllCall("ADVAPI32\OpenTraceFromFile"
    , "WStr", LogFileName   ; LPCWSTR
    , "Ptr", Options   ; ETW_OPEN_TRACE_OPTIONS*
    , "Ptr", LogFileHeader   ; TRACE_LOGFILE_HEADER* optional, out
    , "Ptr")   ; return: PROCESSTRACE_HANDLE
●OpenTraceFromFile(LogFileName, Options, LogFileHeader) = DLL("ADVAPI32.dll", "void* OpenTraceFromFile(char*, void*, void*)")
# 呼び出し: OpenTraceFromFile(LogFileName, Options, LogFileHeader)
# LogFileName : LPCWSTR -> "char*"
# Options : ETW_OPEN_TRACE_OPTIONS* -> "void*"
# LogFileHeader : TRACE_LOGFILE_HEADER* optional, out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef OpenTraceFromFileNative = PROCESSTRACE_HANDLE Function(Pointer<Utf16>, Pointer<Void>, Pointer<Void>);
typedef OpenTraceFromFileDart = int Function(Pointer<Utf16>, Pointer<Void>, Pointer<Void>);
final OpenTraceFromFile = DynamicLibrary.open('ADVAPI32.dll')
    .lookupFunction<OpenTraceFromFileNative, OpenTraceFromFileDart>('OpenTraceFromFile');
// LogFileName : LPCWSTR -> Pointer<Utf16>
// Options : ETW_OPEN_TRACE_OPTIONS* -> Pointer<Void>
// LogFileHeader : TRACE_LOGFILE_HEADER* optional, out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function OpenTraceFromFile(
  LogFileName: PWideChar;   // LPCWSTR
  Options: Pointer;   // ETW_OPEN_TRACE_OPTIONS*
  LogFileHeader: Pointer   // TRACE_LOGFILE_HEADER* optional, out
): PROCESSTRACE_HANDLE; stdcall;
  external 'ADVAPI32.dll' name 'OpenTraceFromFile';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "OpenTraceFromFile"
  c_OpenTraceFromFile :: CWString -> Ptr () -> Ptr () -> IO PROCESSTRACE_HANDLE
-- LogFileName : LPCWSTR -> CWString
-- Options : ETW_OPEN_TRACE_OPTIONS* -> Ptr ()
-- LogFileHeader : TRACE_LOGFILE_HEADER* optional, out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
-- ※値渡し構造体は GHC FFI で直接渡せません。Ptr で渡すラッパ(C側)経由にしてください。
open Ctypes
open Foreign

let opentracefromfile =
  foreign "OpenTraceFromFile"
    ((ptr uint16_t) @-> (ptr void) @-> (ptr void) @-> returning PROCESSTRACE_HANDLE)
(* LogFileName : LPCWSTR -> (ptr uint16_t) *)
(* Options : ETW_OPEN_TRACE_OPTIONS* -> (ptr void) *)
(* LogFileHeader : TRACE_LOGFILE_HEADER* optional, 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 ("OpenTraceFromFile" open-trace-from-file :convention :stdcall) (:struct processtrace-handle)
  (log-file-name (:string :encoding :utf-16le))   ; LPCWSTR
  (options :pointer)   ; ETW_OPEN_TRACE_OPTIONS*
  (log-file-header :pointer))   ; TRACE_LOGFILE_HEADER* optional, out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $OpenTraceFromFile = Win32::API::More->new('ADVAPI32',
    'LPVOID OpenTraceFromFile(LPCWSTR LogFileName, LPVOID Options, LPVOID LogFileHeader)');
# my $ret = $OpenTraceFromFile->Call($LogFileName, $Options, $LogFileHeader);
# LogFileName : LPCWSTR -> LPCWSTR
# Options : ETW_OPEN_TRACE_OPTIONS* -> LPVOID
# LogFileHeader : TRACE_LOGFILE_HEADER* optional, out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型