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

StopTraceA

関数
指定したイベントトレースセッションを停止する(ANSI版)。
DLLADVAPI32.dll文字セットANSI (-A)呼出規約winapi対応OSWindows 2000 以降
📘 Microsoft Learn (日本語) · English

シグネチャ

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

WIN32_ERROR StopTraceA(
    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 文字) を使用して計算できます。

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

戻り値の型: WIN32_ERROR

公式ドキュメント

StopTraceA (ANSI) 関数 (evntrace.h) は、指定されたイベントトレースセッションを停止します。この関数は ControlTrace 関数に置き換えられています。

戻り値

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

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

解説(Remarks)

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

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

LogFileMode に EVENT_TRACE_FILE_MODE_PREALLOCATE が含まれている場合、StartTrace はログファイルを MaximumFileSize バイトまで拡張します。循環ログとシーケンシャルログの両方で、ログ記録中はファイルがその領域全体を占有します。ロガーを停止すると、ログファイルは必要なサイズまで縮小されます。

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

メモ

evntrace.h ヘッダーは、StopTrace を、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 StopTraceA(
    ULONGLONG TraceId,
    LPCSTR InstanceName,   // optional
    EVENT_TRACE_PROPERTIES* Properties
);
[DllImport("ADVAPI32.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint StopTraceA(
    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 StopTraceA(
    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 StopTraceA 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

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

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

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

関連項目

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