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

FlushTraceA

関数
トレースセッションのバッファを強制的にフラッシュする(ANSI版)。
DLLADVAPI32.dll文字セットANSI (-A)呼出規約winapi対応OSWindows XP 以降
📘 Microsoft Learn (日本語) · English

シグネチャ

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

WIN32_ERROR FlushTraceA(
    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 構造体へのポインター。

新しく初期化した構造体を使用する場合は、構造体の Wnode.BufferSize、Wnode.Guid、LoggerNameOffset、LogFileNameOffset の各メンバーを設定するだけで済みます。バッファー サイズとオフセットが不明な場合は、最大セッション名の長さ (1024 文字) と最大ログ ファイル名の長さ (1024 文字) を使用して計算できます。

出力時には、この構造体にイベント トレース セッションのプロパティ設定とセッション統計が格納されます。これらはフラッシュ後のセッションの状態を反映します。

戻り値の型: WIN32_ERROR

公式ドキュメント

FlushTraceA (ANSI) 関数 (evntrace.h) は、指定したセッションについて、イベント トレース セッションがバッファリングされたイベントを直ちに配信するようにします。

戻り値

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

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

解説(Remarks)

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

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

この関数は、インメモリ セッション (EVENT_TRACE_BUFFERING_MODE フラグを指定して開始したセッション) と共に使用して、トレースのデータをファイルに書き込むことができます。

ファイル ベースのセッションやリアルタイム セッションは、通常フラッシュする必要はありません。ETW は、バッファーがいっぱいになったとき (つまり次のイベントを収めるための領域がなくなったとき)、トレース セッションの FlushTimer が満了したとき、またはトレース セッションが閉じられたときに、自動的にバッファーをフラッシュするためです。

DllMain から FlushTrace を呼び出さないでください (デッドロックを引き起こす可能性があります)。

メモ

evntrace.h ヘッダーは FlushTrace をエイリアスとして定義しており、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 FlushTraceA(
    ULONGLONG TraceId,
    LPCSTR InstanceName,   // optional
    EVENT_TRACE_PROPERTIES* Properties
);
[DllImport("ADVAPI32.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint FlushTraceA(
    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 FlushTraceA(
    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 FlushTraceA 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

FlushTraceA = ctypes.windll.advapi32.FlushTraceA
FlushTraceA.restype = wintypes.DWORD
FlushTraceA.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')
FlushTraceA = Fiddle::Function.new(
  lib['FlushTraceA'],
  [
    -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 FlushTraceA(
        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 FlushTraceA(ulong TraceId, [MarshalAs(UnmanagedType.LPStr)] string InstanceName, IntPtr Properties);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_FlushTraceA' -Namespace Win32 -PassThru
# $api::FlushTraceA(TraceId, InstanceName, Properties)
#uselib "ADVAPI32.dll"
#func global FlushTraceA "FlushTraceA" sptr, sptr, sptr
; FlushTraceA 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 FlushTraceA "FlushTraceA" int64, str, var
; res = FlushTraceA(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 FlushTraceA(ULONGLONG TraceId, LPCSTR InstanceName, EVENT_TRACE_PROPERTIES* Properties)
#uselib "ADVAPI32.dll"
#cfunc global FlushTraceA "FlushTraceA" int64, str, var
; res = FlushTraceA(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")
	procFlushTraceA = advapi32.NewProc("FlushTraceA")
)

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

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

関連項目

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