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

QueryTraceA

関数
イベントトレースセッションの現在のプロパティを照会する(ANSI版)。
DLLADVAPI32.dll文字セットANSI (-A)呼出規約winapi対応OSWindows 2000 以降
📘 Microsoft Learn (日本語) · English

シグネチャ

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

WIN32_ERROR QueryTraceA(
    ULONGLONG TraceId,
    LPCSTR InstanceName,   // optional
    EVENT_TRACE_PROPERTIES* Properties
);

パラメーター

名前型方向説明
TraceIdULONGLONGin問い合わせるトレースセッションのハンドル。0の場合は名前で特定。
InstanceNameLPCSTRinoptional

クエリ対象のイベントトレースセッションの名前、または NULL。TraceHandle が 0 の場合は、InstanceName を指定する必要があります。

NT Kernel Logger セッションを指定するには、InstanceName を KERNEL_LOGGER_NAME に設定します。

PropertiesEVENT_TRACE_PROPERTIES*inout

初期化済みの EVENT_TRACE_PROPERTIES 構造体へのポインター。

EVENT_TRACE_PROPERTIES 構造体の Wnode.BufferSize メンバーのみを設定すればよいです。バッファーサイズとオフセットが不明な場合は、セッション名の最大長 (1024 文字) とログファイル名の最大長 (1024 文字) を使用して計算できます。

出力時には、構造体のメンバーにイベントトレースセッションのプロパティ設定とセッション統計情報が格納されます。

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

戻り値の型: WIN32_ERROR

公式ドキュメント

QueryTraceA (ANSI) 関数 (evntrace.h) は、指定したイベントトレースセッションのプロパティ設定とセッション統計情報を取得します。

戻り値

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

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

解説(Remarks)

この関数はイベントトレースコントローラーによって呼び出されます。

この関数は廃止されています。代わりに、ControlCode を EVENT_TRACE_CONTROL_QUERY に設定して ControlTrace を使用してください。

メモ

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 QueryTraceA(
    ULONGLONG TraceId,
    LPCSTR InstanceName,   // optional
    EVENT_TRACE_PROPERTIES* Properties
);
[DllImport("ADVAPI32.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint QueryTraceA(
    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 QueryTraceA(
    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 QueryTraceA 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

QueryTraceA = ctypes.windll.advapi32.QueryTraceA
QueryTraceA.restype = wintypes.DWORD
QueryTraceA.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')
QueryTraceA = Fiddle::Function.new(
  lib['QueryTraceA'],
  [
    -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 QueryTraceA(
        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 QueryTraceA(ulong TraceId, [MarshalAs(UnmanagedType.LPStr)] string InstanceName, IntPtr Properties);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_QueryTraceA' -Namespace Win32 -PassThru
# $api::QueryTraceA(TraceId, InstanceName, Properties)
#uselib "ADVAPI32.dll"
#func global QueryTraceA "QueryTraceA" sptr, sptr, sptr
; QueryTraceA 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 QueryTraceA "QueryTraceA" int64, str, var
; res = QueryTraceA(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 は未対応)。
出力引数: 
; WIN32_ERROR QueryTraceA(ULONGLONG TraceId, LPCSTR InstanceName, EVENT_TRACE_PROPERTIES* Properties)
#uselib "ADVAPI32.dll"
#cfunc global QueryTraceA "QueryTraceA" int64, str, var
; res = QueryTraceA(TraceId, InstanceName, Properties)
; TraceId : ULONGLONG -> "int64"
; InstanceName : LPCSTR optional -> "str"
; Properties : EVENT_TRACE_PROPERTIES* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	advapi32 = windows.NewLazySystemDLL("ADVAPI32.dll")
	procQueryTraceA = advapi32.NewProc("QueryTraceA")
)

// TraceId (ULONGLONG), InstanceName (LPCSTR optional), Properties (EVENT_TRACE_PROPERTIES* in/out)
r1, _, err := procQueryTraceA.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 QueryTraceA(
  TraceId: UInt64;   // ULONGLONG
  InstanceName: PAnsiChar;   // LPCSTR optional
  Properties: Pointer   // EVENT_TRACE_PROPERTIES* in/out
): DWORD; stdcall;
  external 'ADVAPI32.dll' name 'QueryTraceA';
result := DllCall("ADVAPI32\QueryTraceA"
    , "Int64", TraceId   ; ULONGLONG
    , "AStr", InstanceName   ; LPCSTR optional
    , "Ptr", Properties   ; EVENT_TRACE_PROPERTIES* in/out
    , "UInt")   ; return: WIN32_ERROR
●QueryTraceA(TraceId, InstanceName, Properties) = DLL("ADVAPI32.dll", "dword QueryTraceA(qword, char*, void*)")
# 呼び出し: QueryTraceA(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 QueryTraceA(
    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 QueryTraceA(
    TraceId: uint64,  # ULONGLONG
    InstanceName: cstring,  # LPCSTR optional
    Properties: ptr EVENT_TRACE_PROPERTIES  # EVENT_TRACE_PROPERTIES* in/out
): uint32 {.importc: "QueryTraceA", stdcall, dynlib: "ADVAPI32.dll".}
pragma(lib, "advapi32");
extern(Windows)
uint QueryTraceA(
    ulong TraceId,   // ULONGLONG
    const(char)* InstanceName,   // LPCSTR optional
    EVENT_TRACE_PROPERTIES* Properties   // EVENT_TRACE_PROPERTIES* in/out
);
ccall((:QueryTraceA, "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 QueryTraceA(
    uint64_t TraceId,
    const char* InstanceName,
    void* Properties);
]]
local advapi32 = ffi.load("advapi32")
-- advapi32.QueryTraceA(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 QueryTraceA = lib.func('__stdcall', 'QueryTraceA', 'uint32_t', ['uint64_t', 'str', 'void *']);
// QueryTraceA(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", {
  QueryTraceA: { parameters: ["u64", "buffer", "pointer"], result: "u32" },
});
// lib.symbols.QueryTraceA(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 QueryTraceA(
    uint64_t TraceId,
    const char* InstanceName,
    void* Properties);
C, "ADVAPI32.dll");
// $ffi->QueryTraceA(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 QueryTraceA(
        long TraceId,   // ULONGLONG
        String InstanceName,   // LPCSTR optional
        Pointer Properties   // EVENT_TRACE_PROPERTIES* in/out
    );
}
@[Link("advapi32")]
lib LibADVAPI32
  fun QueryTraceA = QueryTraceA(
    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 QueryTraceANative = Uint32 Function(Uint64, Pointer<Utf8>, Pointer<Void>);
typedef QueryTraceADart = int Function(int, Pointer<Utf8>, Pointer<Void>);
final QueryTraceA = DynamicLibrary.open('ADVAPI32.dll')
    .lookupFunction<QueryTraceANative, QueryTraceADart>('QueryTraceA');
// TraceId : ULONGLONG -> Uint64
// InstanceName : LPCSTR optional -> Pointer<Utf8>
// Properties : EVENT_TRACE_PROPERTIES* in/out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function QueryTraceA(
  TraceId: UInt64;   // ULONGLONG
  InstanceName: PAnsiChar;   // LPCSTR optional
  Properties: Pointer   // EVENT_TRACE_PROPERTIES* in/out
): DWORD; stdcall;
  external 'ADVAPI32.dll' name 'QueryTraceA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "QueryTraceA"
  c_QueryTraceA :: 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 querytracea =
  foreign "QueryTraceA"
    (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 ("QueryTraceA" query-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 $QueryTraceA = Win32::API::More->new('ADVAPI32',
    'DWORD QueryTraceA(UINT64 TraceId, LPCSTR InstanceName, LPVOID Properties)');
# my $ret = $QueryTraceA->Call($TraceId, $InstanceName, $Properties);
# TraceId : ULONGLONG -> UINT64
# InstanceName : LPCSTR optional -> LPCSTR
# Properties : EVENT_TRACE_PROPERTIES* in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

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