UpdateTraceA
関数シグネチャ
// ADVAPI32.dll (ANSI / -A)
#include <windows.h>
WIN32_ERROR UpdateTraceA(
ULONGLONG TraceId,
LPCSTR InstanceName, // optional
EVENT_TRACE_PROPERTIES* Properties
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| TraceId | ULONGLONG | in | 更新するトレースセッションのハンドル。0の場合は名前で特定。 |
| InstanceName | LPCSTR | inoptional | 更新するイベント トレース セッションの名前、または NULL。TraceHandle が 0 の場合は、InstanceName を指定する必要があります。 NT Kernel Logger セッションを指定するには、InstanceName に KERNEL_LOGGER_NAME を設定します。 |
| Properties | EVENT_TRACE_PROPERTIES* | inout | 初期化済みの EVENT_TRACE_PROPERTIES 構造体へのポインター。 入力時には、各メンバーで更新するプロパティの新しい値を指定する必要があります。更新可能なプロパティについては、「解説」を参照してください。 出力時には、構造体のメンバーにイベント トレース セッションの更新された設定と統計情報が格納されます。 |
戻り値の型: WIN32_ERROR
公式ドキュメント
UpdateTraceA (ANSI) 関数 (evntrace.h) は、指定したイベント トレース セッションのプロパティ設定を更新します。
戻り値
関数が成功した場合、戻り値は ERROR_SUCCESS です。
関数が失敗した場合、戻り値は システム エラー コード のいずれかになります。次の表に、一般的なエラーとその原因をいくつか示します。
-
Properties の Wnode メンバーの BufferSize メンバーに、誤ったサイズが指定されています。
-
次のいずれかが該当します。
- Properties が NULL です。
- InstanceName と TraceHandle の両方が NULL です。
- InstanceName が NULL で、TraceHandle が有効なハンドルではありません。
- Properties の LogFileNameOffset メンバーが無効です。
- Properties の LoggerNameOffset メンバーが無効です。
Windows Server 2003 および Windows XP: Wnode 構造体の Guid メンバーが SystemTraceControlGuid であるにもかかわらず、InstanceName パラメーターが KERNEL_LOGGER_NAME ではありません。
-
イベント トレース セッションを制御できるのは、管理者特権を持つユーザー、Performance Log Users グループのユーザー、および LocalSystem、LocalService、NetworkService として実行されているサービスのみです。制限されたユーザーにトレース セッションを制御する権限を付与するには、そのユーザーを Performance Log Users グループに追加します。
Windows XP および Windows 2000: 誰でもトレース セッションを制御できます。
解説(Remarks)
この関数はイベント トレース コントローラーが呼び出します。
この関数は廃止されました。代わりに、ControlCode を EVENT_TRACE_CONTROL_UPDATE に設定した ControlTrace を使用してください。
入力時には、各メンバーで更新するプロパティの新しい値を指定する必要があります。次のプロパティを更新できます。
EnableFlags: すべてのカーネル プロバイダーを無効にするには、このメンバーを 0 に設定します。そうでない場合は、有効にする、または有効なままにするカーネル プロバイダーを指定する必要があります。システム ロガー セッションにのみ適用されます。
FlushTimer: バッファーをフラッシュするまでの待機時間を変更する場合は、このメンバーを設定します。このメンバーが 0 の場合、メンバーは更新されません。
LogFileNameOffset: 別のログ ファイルに切り替える場合は、このメンバーを設定します。このメンバーが 0 の場合、ファイル名は更新されません。オフセットが 0 以外であるにもかかわらずログ ファイル名を変更しない場合、関数はエラーを返します。
LogFileMode: EVENT_TRACE_REAL_TIME_MODE のオン/オフを切り替える場合は、このメンバーを設定します。リアルタイム消費をオフにするには、このメンバーを 0 に設定します。リアルタイム消費をオンにするには、このメンバーを EVENT_TRACE_REAL_TIME_MODE に設定します。これは現在のモードと OR 演算されます。
MaximumBuffers: ETW が使用するバッファーの最大数を変更する場合は、このメンバーを設定します。このメンバーが 0 の場合、メンバーは更新されません。
プライベート ロガー セッションでは、LogFileNameOffset と FlushTimer のみを更新できます。
新しく初期化した EVENT_TRACE_PROPERTIES 構造体を使用している場合、更新するメンバー以外に指定する必要があるのは、Wnode.BufferSize、Wnode.Guid、Wnode.Flags のみです。
StartTrace に渡したプロパティ構造体を使用する場合は、ログ ファイル名を変更する場合を除き、LogFileNameOffset メンバーが 0 であることを確認してください。
ControlTrace 関数を呼び出して現在のセッション プロパティを照会し、それらのプロパティを更新してセッションを更新する場合は、(ログ ファイル名を変更する場合を除き) LogFileNameOffset を 0 に設定し、EVENT_TRACE_PROPERTIES.Wnode.Flags を WNODE_FLAG_TRACED_GUID に設定してください。
イベント トレース セッションのプロパティ設定とセッション統計を取得するには、ControlTrace 関数を呼び出します。
例
UpdateTrace を使用する例については、「イベント トレース セッションの更新」を参照してください。
evntrace.h ヘッダーは UpdateTrace をエイリアスとして定義しており、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択します。エンコードに依存しないエイリアスの使用を、エンコードに依存しないわけではないコードと混在させると、コンパイル エラーや実行時エラーを引き起こす不一致が生じる可能性があります。詳細については、「関数プロトタイプの規則」を参照してください。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// ADVAPI32.dll (ANSI / -A)
#include <windows.h>
WIN32_ERROR UpdateTraceA(
ULONGLONG TraceId,
LPCSTR InstanceName, // optional
EVENT_TRACE_PROPERTIES* Properties
);[DllImport("ADVAPI32.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint UpdateTraceA(
ulong TraceId, // ULONGLONG
[MarshalAs(UnmanagedType.LPStr)] string InstanceName, // LPCSTR optional
IntPtr Properties // EVENT_TRACE_PROPERTIES* in/out
);<DllImport("ADVAPI32.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function UpdateTraceA(
TraceId As ULong, ' ULONGLONG
<MarshalAs(UnmanagedType.LPStr)> InstanceName As String, ' LPCSTR optional
Properties As IntPtr ' EVENT_TRACE_PROPERTIES* in/out
) As UInteger
End Function' TraceId : ULONGLONG
' InstanceName : LPCSTR optional
' Properties : EVENT_TRACE_PROPERTIES* in/out
Declare PtrSafe Function UpdateTraceA Lib "advapi32" ( _
ByVal 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
UpdateTraceA = ctypes.windll.advapi32.UpdateTraceA
UpdateTraceA.restype = wintypes.DWORD
UpdateTraceA.argtypes = [
ctypes.c_ulonglong, # TraceId : ULONGLONG
wintypes.LPCSTR, # InstanceName : LPCSTR optional
ctypes.c_void_p, # Properties : EVENT_TRACE_PROPERTIES* in/out
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('ADVAPI32.dll')
UpdateTraceA = Fiddle::Function.new(
lib['UpdateTraceA'],
[
-Fiddle::TYPE_LONG_LONG, # TraceId : ULONGLONG
Fiddle::TYPE_VOIDP, # InstanceName : LPCSTR optional
Fiddle::TYPE_VOIDP, # Properties : EVENT_TRACE_PROPERTIES* in/out
],
-Fiddle::TYPE_INT)#[link(name = "advapi32")]
extern "system" {
fn UpdateTraceA(
TraceId: u64, // ULONGLONG
InstanceName: *const u8, // LPCSTR optional
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 UpdateTraceA(ulong TraceId, [MarshalAs(UnmanagedType.LPStr)] string InstanceName, IntPtr Properties);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_UpdateTraceA' -Namespace Win32 -PassThru
# $api::UpdateTraceA(TraceId, InstanceName, Properties)#uselib "ADVAPI32.dll"
#func global UpdateTraceA "UpdateTraceA" sptr, sptr, sptr
; UpdateTraceA TraceId, InstanceName, varptr(Properties) ; 戻り値は stat
; TraceId : ULONGLONG -> "sptr"
; InstanceName : LPCSTR optional -> "sptr"
; Properties : EVENT_TRACE_PROPERTIES* in/out -> "sptr"
; ※HSP3.7は int64 引数(64bit値渡し)に非対応です。
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "ADVAPI32.dll" #cfunc global UpdateTraceA "UpdateTraceA" int64, str, var ; res = UpdateTraceA(TraceId, InstanceName, Properties) ; TraceId : ULONGLONG -> "int64" ; InstanceName : LPCSTR optional -> "str" ; Properties : EVENT_TRACE_PROPERTIES* in/out -> "var" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。 ; ※int64 引数の DLL 値渡しは x64 ランタイム(hsp3_64)のみ対応(x86 は未対応)。#uselib "ADVAPI32.dll" #cfunc global UpdateTraceA "UpdateTraceA" int64, str, sptr ; res = UpdateTraceA(TraceId, InstanceName, varptr(Properties)) ; TraceId : ULONGLONG -> "int64" ; InstanceName : LPCSTR optional -> "str" ; Properties : EVENT_TRACE_PROPERTIES* in/out -> "sptr" ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。 ; ※int64 引数の DLL 値渡しは x64 ランタイム(hsp3_64)のみ対応(x86 は未対応)。
; WIN32_ERROR UpdateTraceA(ULONGLONG TraceId, LPCSTR InstanceName, EVENT_TRACE_PROPERTIES* Properties) #uselib "ADVAPI32.dll" #cfunc global UpdateTraceA "UpdateTraceA" int64, str, var ; res = UpdateTraceA(TraceId, InstanceName, Properties) ; TraceId : ULONGLONG -> "int64" ; InstanceName : LPCSTR optional -> "str" ; Properties : EVENT_TRACE_PROPERTIES* in/out -> "var" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; WIN32_ERROR UpdateTraceA(ULONGLONG TraceId, LPCSTR InstanceName, EVENT_TRACE_PROPERTIES* Properties) #uselib "ADVAPI32.dll" #cfunc global UpdateTraceA "UpdateTraceA" int64, str, intptr ; res = UpdateTraceA(TraceId, InstanceName, varptr(Properties)) ; TraceId : ULONGLONG -> "int64" ; InstanceName : LPCSTR optional -> "str" ; Properties : EVENT_TRACE_PROPERTIES* in/out -> "intptr" ; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。
import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
advapi32 = windows.NewLazySystemDLL("ADVAPI32.dll")
procUpdateTraceA = advapi32.NewProc("UpdateTraceA")
)
// TraceId (ULONGLONG), InstanceName (LPCSTR optional), Properties (EVENT_TRACE_PROPERTIES* in/out)
r1, _, err := procUpdateTraceA.Call(
uintptr(TraceId),
uintptr(unsafe.Pointer(windows.BytePtrFromString(InstanceName))),
uintptr(Properties),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // WIN32_ERRORfunction UpdateTraceA(
TraceId: UInt64; // ULONGLONG
InstanceName: PAnsiChar; // LPCSTR optional
Properties: Pointer // EVENT_TRACE_PROPERTIES* in/out
): DWORD; stdcall;
external 'ADVAPI32.dll' name 'UpdateTraceA';result := DllCall("ADVAPI32\UpdateTraceA"
, "Int64", TraceId ; ULONGLONG
, "AStr", InstanceName ; LPCSTR optional
, "Ptr", Properties ; EVENT_TRACE_PROPERTIES* in/out
, "UInt") ; return: WIN32_ERROR●UpdateTraceA(TraceId, InstanceName, Properties) = DLL("ADVAPI32.dll", "dword UpdateTraceA(qword, char*, void*)")
# 呼び出し: UpdateTraceA(TraceId, InstanceName, Properties)
# TraceId : ULONGLONG -> "qword"
# InstanceName : LPCSTR optional -> "char*"
# Properties : EVENT_TRACE_PROPERTIES* in/out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "advapi32" fn UpdateTraceA(
TraceId: u64, // ULONGLONG
InstanceName: [*c]const u8, // LPCSTR optional
Properties: [*c]EVENT_TRACE_PROPERTIES // EVENT_TRACE_PROPERTIES* in/out
) callconv(std.os.windows.WINAPI) u32;proc UpdateTraceA(
TraceId: uint64, # ULONGLONG
InstanceName: cstring, # LPCSTR optional
Properties: ptr EVENT_TRACE_PROPERTIES # EVENT_TRACE_PROPERTIES* in/out
): uint32 {.importc: "UpdateTraceA", stdcall, dynlib: "ADVAPI32.dll".}pragma(lib, "advapi32");
extern(Windows)
uint UpdateTraceA(
ulong TraceId, // ULONGLONG
const(char)* InstanceName, // LPCSTR optional
EVENT_TRACE_PROPERTIES* Properties // EVENT_TRACE_PROPERTIES* in/out
);ccall((:UpdateTraceA, "ADVAPI32.dll"), stdcall, UInt32,
(UInt64, Cstring, Ptr{EVENT_TRACE_PROPERTIES}),
TraceId, InstanceName, Properties)
# TraceId : ULONGLONG -> UInt64
# InstanceName : LPCSTR optional -> Cstring
# Properties : EVENT_TRACE_PROPERTIES* in/out -> Ptr{EVENT_TRACE_PROPERTIES}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
uint32_t UpdateTraceA(
uint64_t TraceId,
const char* InstanceName,
void* Properties);
]]
local advapi32 = ffi.load("advapi32")
-- advapi32.UpdateTraceA(TraceId, InstanceName, Properties)
-- TraceId : ULONGLONG
-- InstanceName : LPCSTR optional
-- Properties : EVENT_TRACE_PROPERTIES* in/out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('ADVAPI32.dll');
const UpdateTraceA = lib.func('__stdcall', 'UpdateTraceA', 'uint32_t', ['uint64_t', 'str', 'void *']);
// UpdateTraceA(TraceId, InstanceName, Properties)
// TraceId : ULONGLONG -> 'uint64_t'
// InstanceName : LPCSTR optional -> 'str'
// Properties : EVENT_TRACE_PROPERTIES* in/out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("ADVAPI32.dll", {
UpdateTraceA: { parameters: ["u64", "buffer", "pointer"], result: "u32" },
});
// lib.symbols.UpdateTraceA(TraceId, InstanceName, Properties)
// TraceId : ULONGLONG -> "u64"
// InstanceName : LPCSTR optional -> "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 UpdateTraceA(
uint64_t TraceId,
const char* InstanceName,
void* Properties);
C, "ADVAPI32.dll");
// $ffi->UpdateTraceA(TraceId, InstanceName, Properties);
// TraceId : ULONGLONG
// InstanceName : LPCSTR optional
// 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 UpdateTraceA(
long TraceId, // ULONGLONG
String InstanceName, // LPCSTR optional
Pointer Properties // EVENT_TRACE_PROPERTIES* in/out
);
}@[Link("advapi32")]
lib LibADVAPI32
fun UpdateTraceA = UpdateTraceA(
TraceId : UInt64, # ULONGLONG
InstanceName : UInt8*, # LPCSTR optional
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 UpdateTraceANative = Uint32 Function(Uint64, Pointer<Utf8>, Pointer<Void>);
typedef UpdateTraceADart = int Function(int, Pointer<Utf8>, Pointer<Void>);
final UpdateTraceA = DynamicLibrary.open('ADVAPI32.dll')
.lookupFunction<UpdateTraceANative, UpdateTraceADart>('UpdateTraceA');
// TraceId : ULONGLONG -> Uint64
// InstanceName : LPCSTR optional -> Pointer<Utf8>
// Properties : EVENT_TRACE_PROPERTIES* in/out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function UpdateTraceA(
TraceId: UInt64; // ULONGLONG
InstanceName: PAnsiChar; // LPCSTR optional
Properties: Pointer // EVENT_TRACE_PROPERTIES* in/out
): DWORD; stdcall;
external 'ADVAPI32.dll' name 'UpdateTraceA';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "UpdateTraceA"
c_UpdateTraceA :: Word64 -> CString -> Ptr () -> IO Word32
-- TraceId : ULONGLONG -> Word64
-- InstanceName : LPCSTR optional -> CString
-- Properties : EVENT_TRACE_PROPERTIES* in/out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let updatetracea =
foreign "UpdateTraceA"
(uint64_t @-> string @-> (ptr void) @-> returning uint32_t)
(* TraceId : ULONGLONG -> uint64_t *)
(* InstanceName : LPCSTR optional -> 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 ("UpdateTraceA" update-trace-a :convention :stdcall) :uint32
(trace-id :uint64) ; ULONGLONG
(instance-name :string) ; LPCSTR optional
(properties :pointer)) ; EVENT_TRACE_PROPERTIES* in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $UpdateTraceA = Win32::API::More->new('ADVAPI32',
'DWORD UpdateTraceA(UINT64 TraceId, LPCSTR InstanceName, LPVOID Properties)');
# my $ret = $UpdateTraceA->Call($TraceId, $InstanceName, $Properties);
# TraceId : ULONGLONG -> UINT64
# InstanceName : LPCSTR optional -> LPCSTR
# Properties : EVENT_TRACE_PROPERTIES* in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
- f UpdateTraceW (Unicode版) — 実行中のトレースセッションの設定を更新する(Unicode版)。