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

StopTraceW

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

シグネチャ

// ADVAPI32.dll  (Unicode / -W)
#include <windows.h>

WIN32_ERROR StopTraceW(
    ULONGLONG TraceId,
    LPCWSTR InstanceName,   // optional
    EVENT_TRACE_PROPERTIES* Properties
);

パラメーター

名前型方向説明
TraceIdULONGLONGin停止するトレースセッションのハンドル。0の場合は名前で特定。
InstanceNameLPCWSTRinoptional

停止するイベントトレースセッションの名前、または 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 構造体を渡す必要があります。詳細については、Configuring and Starting a Private Logger Session を参照してください。

戻り値の型: WIN32_ERROR

公式ドキュメント

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

戻り値

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

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

解説(Remarks)

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

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

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

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

メモ

evntrace.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして StopTrace を定義しています。エンコーディング非依存のエイリアスを、エンコーディング非依存ではないコードと混在させて使用すると、不一致が生じ、コンパイルエラーまたは実行時エラーの原因となる場合があります。詳細については、Conventions for Function Prototypes を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// ADVAPI32.dll  (Unicode / -W)
#include <windows.h>

WIN32_ERROR StopTraceW(
    ULONGLONG TraceId,
    LPCWSTR InstanceName,   // optional
    EVENT_TRACE_PROPERTIES* Properties
);
[DllImport("ADVAPI32.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern uint StopTraceW(
    ulong TraceId,   // ULONGLONG
    [MarshalAs(UnmanagedType.LPWStr)] string InstanceName,   // LPCWSTR optional
    IntPtr Properties   // EVENT_TRACE_PROPERTIES* in/out
);
<DllImport("ADVAPI32.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function StopTraceW(
    TraceId As ULong,   ' ULONGLONG
    <MarshalAs(UnmanagedType.LPWStr)> InstanceName As String,   ' LPCWSTR optional
    Properties As IntPtr   ' EVENT_TRACE_PROPERTIES* in/out
) As UInteger
End Function
' TraceId : ULONGLONG
' InstanceName : LPCWSTR optional
' Properties : EVENT_TRACE_PROPERTIES* in/out
Declare PtrSafe Function StopTraceW Lib "advapi32" ( _
    ByVal TraceId As LongLong, _
    ByVal InstanceName As LongPtr, _
    ByVal Properties As LongPtr) As Long
' 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

StopTraceW = ctypes.windll.advapi32.StopTraceW
StopTraceW.restype = wintypes.DWORD
StopTraceW.argtypes = [
    ctypes.c_ulonglong,  # TraceId : ULONGLONG
    wintypes.LPCWSTR,  # InstanceName : LPCWSTR optional
    ctypes.c_void_p,  # Properties : EVENT_TRACE_PROPERTIES* in/out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ADVAPI32.dll')
StopTraceW = Fiddle::Function.new(
  lib['StopTraceW'],
  [
    -Fiddle::TYPE_LONG_LONG,  # TraceId : ULONGLONG
    Fiddle::TYPE_VOIDP,  # InstanceName : LPCWSTR optional
    Fiddle::TYPE_VOIDP,  # Properties : EVENT_TRACE_PROPERTIES* in/out
  ],
  -Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "advapi32")]
extern "system" {
    fn StopTraceW(
        TraceId: u64,  // ULONGLONG
        InstanceName: *const u16,  // LPCWSTR 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.Unicode)]
public static extern uint StopTraceW(ulong TraceId, [MarshalAs(UnmanagedType.LPWStr)] string InstanceName, IntPtr Properties);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_StopTraceW' -Namespace Win32 -PassThru
# $api::StopTraceW(TraceId, InstanceName, Properties)
#uselib "ADVAPI32.dll"
#func global StopTraceW "StopTraceW" wptr, wptr, wptr
; StopTraceW TraceId, InstanceName, varptr(Properties)   ; 戻り値は stat
; TraceId : ULONGLONG -> "wptr"
; InstanceName : LPCWSTR optional -> "wptr"
; Properties : EVENT_TRACE_PROPERTIES* in/out -> "wptr"
; ※HSP3.7は int64 引数(64bit値渡し)に非対応です。
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数: 
#uselib "ADVAPI32.dll"
#cfunc global StopTraceW "StopTraceW" int64, wstr, var
; res = StopTraceW(TraceId, InstanceName, Properties)
; TraceId : ULONGLONG -> "int64"
; InstanceName : LPCWSTR optional -> "wstr"
; Properties : EVENT_TRACE_PROPERTIES* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
; ※int64 引数の DLL 値渡しは x64 ランタイム(hsp3_64)のみ対応(x86 は未対応)。
出力引数: 
; WIN32_ERROR StopTraceW(ULONGLONG TraceId, LPCWSTR InstanceName, EVENT_TRACE_PROPERTIES* Properties)
#uselib "ADVAPI32.dll"
#cfunc global StopTraceW "StopTraceW" int64, wstr, var
; res = StopTraceW(TraceId, InstanceName, Properties)
; TraceId : ULONGLONG -> "int64"
; InstanceName : LPCWSTR optional -> "wstr"
; Properties : EVENT_TRACE_PROPERTIES* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	advapi32 = windows.NewLazySystemDLL("ADVAPI32.dll")
	procStopTraceW = advapi32.NewProc("StopTraceW")
)

// TraceId (ULONGLONG), InstanceName (LPCWSTR optional), Properties (EVENT_TRACE_PROPERTIES* in/out)
r1, _, err := procStopTraceW.Call(
	uintptr(TraceId),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(InstanceName))),
	uintptr(Properties),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // WIN32_ERROR
function StopTraceW(
  TraceId: UInt64;   // ULONGLONG
  InstanceName: PWideChar;   // LPCWSTR optional
  Properties: Pointer   // EVENT_TRACE_PROPERTIES* in/out
): DWORD; stdcall;
  external 'ADVAPI32.dll' name 'StopTraceW';
result := DllCall("ADVAPI32\StopTraceW"
    , "Int64", TraceId   ; ULONGLONG
    , "WStr", InstanceName   ; LPCWSTR optional
    , "Ptr", Properties   ; EVENT_TRACE_PROPERTIES* in/out
    , "UInt")   ; return: WIN32_ERROR
●StopTraceW(TraceId, InstanceName, Properties) = DLL("ADVAPI32.dll", "dword StopTraceW(qword, char*, void*)")
# 呼び出し: StopTraceW(TraceId, InstanceName, Properties)
# TraceId : ULONGLONG -> "qword"
# InstanceName : LPCWSTR optional -> "char*"
# Properties : EVENT_TRACE_PROPERTIES* in/out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "advapi32" fn StopTraceW(
    TraceId: u64, // ULONGLONG
    InstanceName: [*c]const u16, // LPCWSTR optional
    Properties: [*c]EVENT_TRACE_PROPERTIES // EVENT_TRACE_PROPERTIES* in/out
) callconv(std.os.windows.WINAPI) u32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc StopTraceW(
    TraceId: uint64,  # ULONGLONG
    InstanceName: WideCString,  # LPCWSTR optional
    Properties: ptr EVENT_TRACE_PROPERTIES  # EVENT_TRACE_PROPERTIES* in/out
): uint32 {.importc: "StopTraceW", stdcall, dynlib: "ADVAPI32.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "advapi32");
extern(Windows)
uint StopTraceW(
    ulong TraceId,   // ULONGLONG
    const(wchar)* InstanceName,   // LPCWSTR optional
    EVENT_TRACE_PROPERTIES* Properties   // EVENT_TRACE_PROPERTIES* in/out
);
ccall((:StopTraceW, "ADVAPI32.dll"), stdcall, UInt32,
      (UInt64, Cwstring, Ptr{EVENT_TRACE_PROPERTIES}),
      TraceId, InstanceName, Properties)
# TraceId : ULONGLONG -> UInt64
# InstanceName : LPCWSTR optional -> Cwstring
# Properties : EVENT_TRACE_PROPERTIES* in/out -> Ptr{EVENT_TRACE_PROPERTIES}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
uint32_t StopTraceW(
    uint64_t TraceId,
    const uint16_t* InstanceName,
    void* Properties);
]]
local advapi32 = ffi.load("advapi32")
-- advapi32.StopTraceW(TraceId, InstanceName, Properties)
-- TraceId : ULONGLONG
-- InstanceName : LPCWSTR optional
-- Properties : EVENT_TRACE_PROPERTIES* 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 StopTraceW = lib.func('__stdcall', 'StopTraceW', 'uint32_t', ['uint64_t', 'str16', 'void *']);
// StopTraceW(TraceId, InstanceName, Properties)
// TraceId : ULONGLONG -> 'uint64_t'
// InstanceName : LPCWSTR optional -> 'str16'
// Properties : EVENT_TRACE_PROPERTIES* in/out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("ADVAPI32.dll", {
  StopTraceW: { parameters: ["u64", "buffer", "pointer"], result: "u32" },
});
// lib.symbols.StopTraceW(TraceId, InstanceName, Properties)
// TraceId : ULONGLONG -> "u64"
// InstanceName : LPCWSTR optional -> "buffer"
// Properties : EVENT_TRACE_PROPERTIES* in/out -> "pointer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t StopTraceW(
    uint64_t TraceId,
    const uint16_t* InstanceName,
    void* Properties);
C, "ADVAPI32.dll");
// $ffi->StopTraceW(TraceId, InstanceName, Properties);
// TraceId : ULONGLONG
// InstanceName : LPCWSTR 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.UNICODE_OPTIONS);
    int StopTraceW(
        long TraceId,   // ULONGLONG
        WString InstanceName,   // LPCWSTR optional
        Pointer Properties   // EVENT_TRACE_PROPERTIES* in/out
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("advapi32")]
lib LibADVAPI32
  fun StopTraceW = StopTraceW(
    TraceId : UInt64,   # ULONGLONG
    InstanceName : UInt16*,   # LPCWSTR 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 StopTraceWNative = Uint32 Function(Uint64, Pointer<Utf16>, Pointer<Void>);
typedef StopTraceWDart = int Function(int, Pointer<Utf16>, Pointer<Void>);
final StopTraceW = DynamicLibrary.open('ADVAPI32.dll')
    .lookupFunction<StopTraceWNative, StopTraceWDart>('StopTraceW');
// TraceId : ULONGLONG -> Uint64
// InstanceName : LPCWSTR optional -> Pointer<Utf16>
// Properties : EVENT_TRACE_PROPERTIES* in/out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function StopTraceW(
  TraceId: UInt64;   // ULONGLONG
  InstanceName: PWideChar;   // LPCWSTR optional
  Properties: Pointer   // EVENT_TRACE_PROPERTIES* in/out
): DWORD; stdcall;
  external 'ADVAPI32.dll' name 'StopTraceW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "StopTraceW"
  c_StopTraceW :: Word64 -> CWString -> Ptr () -> IO Word32
-- TraceId : ULONGLONG -> Word64
-- InstanceName : LPCWSTR optional -> CWString
-- Properties : EVENT_TRACE_PROPERTIES* in/out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let stoptracew =
  foreign "StopTraceW"
    (uint64_t @-> (ptr uint16_t) @-> (ptr void) @-> returning uint32_t)
(* TraceId : ULONGLONG -> uint64_t *)
(* InstanceName : LPCWSTR optional -> (ptr uint16_t) *)
(* 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 ("StopTraceW" stop-trace-w :convention :stdcall) :uint32
  (trace-id :uint64)   ; ULONGLONG
  (instance-name (:string :encoding :utf-16le))   ; LPCWSTR optional
  (properties :pointer))   ; EVENT_TRACE_PROPERTIES* in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $StopTraceW = Win32::API::More->new('ADVAPI32',
    'DWORD StopTraceW(UINT64 TraceId, LPCWSTR InstanceName, LPVOID Properties)');
# my $ret = $StopTraceW->Call($TraceId, $InstanceName, $Properties);
# TraceId : ULONGLONG -> UINT64
# InstanceName : LPCWSTR optional -> LPCWSTR
# Properties : EVENT_TRACE_PROPERTIES* in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

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