OpenTraceW
関数シグネチャ
// ADVAPI32.dll (Unicode / -W)
#include <windows.h>
PROCESSTRACE_HANDLE OpenTraceW(
EVENT_TRACE_LOGFILEW* Logfile
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| Logfile | EVENT_TRACE_LOGFILEW* | inout | EVENT_TRACE_LOGFILE 構造体へのポインター。この構造体は、イベントの消費元 (ETW ログファイルまたは リアルタイム ETW セッション) を指定し、コンシューマーがイベントを受け取るために使用する コールバックを指定します。成功すると、OpenTrace は開いたファイルまたはセッションの情報で 構造体を更新します。 |
戻り値の型: PROCESSTRACE_HANDLE
公式ドキュメント
OpenTraceW (Unicode) 関数 (evntrace.h) は、ETW リアルタイムトレースセッションまたは ETW ログファイルからイベントを消費するための ETW トレース処理ハンドルを開きます。
戻り値
関数が成功した場合、トレース処理ハンドルを返します。このハンドルは CloseTrace を使用して閉じる必要があります。
関数が失敗した場合、INVALID_PROCESSTRACE_HANDLE を返します。
(INVALID_PROCESSTRACE_HANDLE は (UINT64)UINTPTR_MAX と等価です。)
Windows Vista より前では、OpenTrace は失敗時に UINT64_MAX を返していました。
古いオペレーティングシステム (Windows XP または Windows Server 2003) と
新しいバージョンの Windows (Windows Vista 以降) の両方をコードでサポートする場合は、
実行中のオペレーティングシステムを判別し、戻り値を適切な値と比較する必要があります。
| オペレーティングシステム | プロセスの種類 | 失敗を示す値 |
|---|---|---|
| Windows Vista より前 | 32 ビットまたは 64 ビット | 0XFFFFFFFFFFFFFFFF = UINT64_MAX |
| Windows Vista 以降 | 32 ビット | 0x00000000FFFFFFFF = (UINT64)UINTPTR_MAX |
| Windows Vista 以降 | 64 ビット | 0XFFFFFFFFFFFFFFFF = (UINT64)UINTPTR_MAX |
関数が失敗した場合は、 GetLastError 関数を使用して拡張エラー情報を取得できます。以下は代表的なエラーとその原因です。
-
Logfile パラメーターが NULL です。
-
EVENT_TRACE_LOGFILE の LoggerName メンバーを指定しなかった場合は、有効なログファイル名を指定する必要があります。
-
リアルタイムでイベントを消費できるのは、管理者特権を持つユーザー、Performance Log Users グループのユーザー、および LocalSystem、LocalService、NetworkService として実行される サービスのみです。制限されたユーザーにリアルタイムでイベントを消費する権限を付与するには、 そのユーザーを Performance Log Users グループに追加します。
Windows XP および Windows 2000: 誰でもリアルタイムイベントを消費できます。
解説(Remarks)
トレースコンシューマーは、トレース処理セッションを開くためにこの関数を呼び出します。
OpenTrace を呼び出した後、 ProcessTrace 関数を呼び出して イベントを処理します。イベントの処理が完了したら、 CloseTrace 関数を呼び出して トレース処理ハンドルを閉じます。
例
OpenTrace を使用する例については、 TdhFormatProperty を使用してイベントデータを消費する を参照してください。
evntrace.h ヘッダーは OpenTrace をエイリアスとして定義しており、UNICODE プリプロセッサ定数の 定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択します。 エンコードに依存しないエイリアスの使用を、エンコードに依存しないわけではないコードと混在させると、 不一致が生じてコンパイルエラーや実行時エラーの原因となる場合があります。詳細については、 関数プロトタイプの規則 を参照してください。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// ADVAPI32.dll (Unicode / -W)
#include <windows.h>
PROCESSTRACE_HANDLE OpenTraceW(
EVENT_TRACE_LOGFILEW* Logfile
);[DllImport("ADVAPI32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern PROCESSTRACE_HANDLE OpenTraceW(
IntPtr Logfile // EVENT_TRACE_LOGFILEW* in/out
);<DllImport("ADVAPI32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function OpenTraceW(
Logfile As IntPtr ' EVENT_TRACE_LOGFILEW* in/out
) As PROCESSTRACE_HANDLE
End Function' Logfile : EVENT_TRACE_LOGFILEW* in/out
Declare PtrSafe Function OpenTraceW Lib "advapi32" ( _
ByVal Logfile As LongPtr) As LongPtr
' 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
OpenTraceW = ctypes.windll.advapi32.OpenTraceW
OpenTraceW.restype = ctypes.c_void_p
OpenTraceW.argtypes = [
ctypes.c_void_p, # Logfile : EVENT_TRACE_LOGFILEW* in/out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('ADVAPI32.dll')
OpenTraceW = Fiddle::Function.new(
lib['OpenTraceW'],
[
Fiddle::TYPE_VOIDP, # Logfile : EVENT_TRACE_LOGFILEW* in/out
],
Fiddle::TYPE_VOIDP)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"#[link(name = "advapi32")]
extern "system" {
fn OpenTraceW(
Logfile: *mut EVENT_TRACE_LOGFILEW // EVENT_TRACE_LOGFILEW* in/out
) -> PROCESSTRACE_HANDLE;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[DllImport("ADVAPI32.dll", CharSet = CharSet.Unicode, SetLastError = true)]
public static extern PROCESSTRACE_HANDLE OpenTraceW(IntPtr Logfile);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_OpenTraceW' -Namespace Win32 -PassThru
# $api::OpenTraceW(Logfile)#uselib "ADVAPI32.dll"
#func global OpenTraceW "OpenTraceW" wptr
; OpenTraceW varptr(Logfile) ; 戻り値は stat
; Logfile : EVENT_TRACE_LOGFILEW* in/out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "ADVAPI32.dll" #cfunc global OpenTraceW "OpenTraceW" var ; res = OpenTraceW(Logfile) ; Logfile : EVENT_TRACE_LOGFILEW* in/out -> "var" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "ADVAPI32.dll" #cfunc global OpenTraceW "OpenTraceW" sptr ; res = OpenTraceW(varptr(Logfile)) ; Logfile : EVENT_TRACE_LOGFILEW* in/out -> "sptr" ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; PROCESSTRACE_HANDLE OpenTraceW(EVENT_TRACE_LOGFILEW* Logfile) #uselib "ADVAPI32.dll" #cfunc global OpenTraceW "OpenTraceW" var ; res = OpenTraceW(Logfile) ; Logfile : EVENT_TRACE_LOGFILEW* in/out -> "var" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; PROCESSTRACE_HANDLE OpenTraceW(EVENT_TRACE_LOGFILEW* Logfile) #uselib "ADVAPI32.dll" #cfunc global OpenTraceW "OpenTraceW" intptr ; res = OpenTraceW(varptr(Logfile)) ; Logfile : EVENT_TRACE_LOGFILEW* in/out -> "intptr" ; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。
import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
advapi32 = windows.NewLazySystemDLL("ADVAPI32.dll")
procOpenTraceW = advapi32.NewProc("OpenTraceW")
)
// Logfile (EVENT_TRACE_LOGFILEW* in/out)
r1, _, err := procOpenTraceW.Call(
uintptr(Logfile),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // PROCESSTRACE_HANDLEfunction OpenTraceW(
Logfile: Pointer // EVENT_TRACE_LOGFILEW* in/out
): PROCESSTRACE_HANDLE; stdcall;
external 'ADVAPI32.dll' name 'OpenTraceW';result := DllCall("ADVAPI32\OpenTraceW"
, "Ptr", Logfile ; EVENT_TRACE_LOGFILEW* in/out
, "Ptr") ; return: PROCESSTRACE_HANDLE●OpenTraceW(Logfile) = DLL("ADVAPI32.dll", "void* OpenTraceW(void*)")
# 呼び出し: OpenTraceW(Logfile)
# Logfile : EVENT_TRACE_LOGFILEW* in/out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。const std = @import("std");
extern "advapi32" fn OpenTraceW(
Logfile: [*c]EVENT_TRACE_LOGFILEW // EVENT_TRACE_LOGFILEW* in/out
) callconv(std.os.windows.WINAPI) PROCESSTRACE_HANDLE;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。proc OpenTraceW(
Logfile: ptr EVENT_TRACE_LOGFILEW # EVENT_TRACE_LOGFILEW* in/out
): PROCESSTRACE_HANDLE {.importc: "OpenTraceW", stdcall, dynlib: "ADVAPI32.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。pragma(lib, "advapi32");
extern(Windows)
PROCESSTRACE_HANDLE OpenTraceW(
EVENT_TRACE_LOGFILEW* Logfile // EVENT_TRACE_LOGFILEW* in/out
);ccall((:OpenTraceW, "ADVAPI32.dll"), stdcall, PROCESSTRACE_HANDLE,
(Ptr{EVENT_TRACE_LOGFILEW},),
Logfile)
# Logfile : EVENT_TRACE_LOGFILEW* in/out -> Ptr{EVENT_TRACE_LOGFILEW}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。local ffi = require("ffi")
ffi.cdef[[
PROCESSTRACE_HANDLE OpenTraceW(
void* Logfile);
]]
local advapi32 = ffi.load("advapi32")
-- advapi32.OpenTraceW(Logfile)
-- Logfile : EVENT_TRACE_LOGFILEW* 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 OpenTraceW = lib.func('__stdcall', 'OpenTraceW', 'PROCESSTRACE_HANDLE', ['void *']);
// OpenTraceW(Logfile)
// Logfile : EVENT_TRACE_LOGFILEW* in/out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("ADVAPI32.dll", {
OpenTraceW: { parameters: ["pointer"], result: "pointer" },
});
// lib.symbols.OpenTraceW(Logfile)
// Logfile : EVENT_TRACE_LOGFILEW* in/out -> "pointer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
PROCESSTRACE_HANDLE OpenTraceW(
void* Logfile);
C, "ADVAPI32.dll");
// $ffi->OpenTraceW(Logfile);
// Logfile : EVENT_TRACE_LOGFILEW* 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);
PROCESSTRACE_HANDLE OpenTraceW(
Pointer Logfile // EVENT_TRACE_LOGFILEW* in/out
);
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。@[Link("advapi32")]
lib LibADVAPI32
fun OpenTraceW = OpenTraceW(
Logfile : EVENT_TRACE_LOGFILEW* # EVENT_TRACE_LOGFILEW* in/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 OpenTraceWNative = PROCESSTRACE_HANDLE Function(Pointer<Void>);
typedef OpenTraceWDart = int Function(Pointer<Void>);
final OpenTraceW = DynamicLibrary.open('ADVAPI32.dll')
.lookupFunction<OpenTraceWNative, OpenTraceWDart>('OpenTraceW');
// Logfile : EVENT_TRACE_LOGFILEW* in/out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function OpenTraceW(
Logfile: Pointer // EVENT_TRACE_LOGFILEW* in/out
): PROCESSTRACE_HANDLE; stdcall;
external 'ADVAPI32.dll' name 'OpenTraceW';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "OpenTraceW"
c_OpenTraceW :: Ptr () -> IO PROCESSTRACE_HANDLE
-- Logfile : EVENT_TRACE_LOGFILEW* in/out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
-- ※値渡し構造体は GHC FFI で直接渡せません。Ptr で渡すラッパ(C側)経由にしてください。open Ctypes
open Foreign
let opentracew =
foreign "OpenTraceW"
((ptr void) @-> returning PROCESSTRACE_HANDLE)
(* Logfile : EVENT_TRACE_LOGFILEW* 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 ("OpenTraceW" open-trace-w :convention :stdcall) (:struct processtrace-handle)
(logfile :pointer)) ; EVENT_TRACE_LOGFILEW* in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $OpenTraceW = Win32::API::More->new('ADVAPI32',
'LPVOID OpenTraceW(LPVOID Logfile)');
# my $ret = $OpenTraceW->Call($Logfile);
# Logfile : EVENT_TRACE_LOGFILEW* in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。関連項目
- f OpenTraceA (ANSI版) — イベントトレースログファイルまたはセッションを消費用に開く(ANSI版)。