ホーム › System.Diagnostics.Etw › GetTraceEnableFlags
GetTraceEnableFlags
関数指定トレースハンドルで有効な有効化フラグを取得する。
シグネチャ
// ADVAPI32.dll
#include <windows.h>
DWORD GetTraceEnableFlags(
ULONGLONG TraceHandle
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| TraceHandle | ULONGLONG | in | イベントトレースセッションへのハンドル。 GetTraceLoggerHandle 関数を呼び出して取得します。 |
戻り値の型: DWORD
公式ドキュメント
RegisterTraceGuids ベース("Classic")のイベントプロバイダーが使用します。
戻り値
コントローラーが EnableTrace 関数を呼び出した際に、 EnableFlag パラメーターで指定した値を返します。
関数が失敗したのか、それともコントローラーが enable flags に 0 を設定したのかを判別するには、 次の手順に従います。
- SetLastError 関数を呼び出して、最後のエラーを ERROR_SUCCESS に設定します。
- GetTraceEnableFlags 関数を呼び出して enable flags を取得します。
- enable flags の値が 0 の場合は、 GetLastError 関数を呼び出して、最後に判明したエラーを取得します。
- 最後に判明したエラーが ERROR_SUCCESS であれば、コントローラーが enable flags に 0 を設定したことを意味します。それ以外の場合は、GetTraceEnableFlags 関数が、 その最後に判明したエラーで失敗しています。
解説(Remarks)
プロバイダーはこの値を使用して、生成するイベントを制御できます。たとえば、プロバイダーは イベントを論理的なカテゴリにグループ化し、この値を使ってそれらの生成を有効または無効に できます。
例
GetTraceEnableFlags を使用する例については、 Retrieving Event Data Using MOF を参照してください。
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// ADVAPI32.dll
#include <windows.h>
DWORD GetTraceEnableFlags(
ULONGLONG TraceHandle
);[DllImport("ADVAPI32.dll", SetLastError = true, ExactSpelling = true)]
static extern uint GetTraceEnableFlags(
ulong TraceHandle // ULONGLONG
);<DllImport("ADVAPI32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetTraceEnableFlags(
TraceHandle As ULong ' ULONGLONG
) As UInteger
End Function' TraceHandle : ULONGLONG
Declare PtrSafe Function GetTraceEnableFlags Lib "advapi32" ( _
ByVal TraceHandle As LongLong) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
GetTraceEnableFlags = ctypes.windll.advapi32.GetTraceEnableFlags
GetTraceEnableFlags.restype = wintypes.DWORD
GetTraceEnableFlags.argtypes = [
ctypes.c_ulonglong, # TraceHandle : ULONGLONG
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('ADVAPI32.dll')
GetTraceEnableFlags = Fiddle::Function.new(
lib['GetTraceEnableFlags'],
[
-Fiddle::TYPE_LONG_LONG, # TraceHandle : ULONGLONG
],
-Fiddle::TYPE_INT)#[link(name = "advapi32")]
extern "system" {
fn GetTraceEnableFlags(
TraceHandle: u64 // ULONGLONG
) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[DllImport("ADVAPI32.dll", SetLastError = true)]
public static extern uint GetTraceEnableFlags(ulong TraceHandle);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_GetTraceEnableFlags' -Namespace Win32 -PassThru
# $api::GetTraceEnableFlags(TraceHandle)#uselib "ADVAPI32.dll"
#func global GetTraceEnableFlags "GetTraceEnableFlags" sptr
; GetTraceEnableFlags TraceHandle ; 戻り値は stat
; TraceHandle : ULONGLONG -> "sptr"
; ※HSP3.7は int64 引数(64bit値渡し)に非対応です。
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "ADVAPI32.dll"
#cfunc global GetTraceEnableFlags "GetTraceEnableFlags" int64
; res = GetTraceEnableFlags(TraceHandle)
; TraceHandle : ULONGLONG -> "int64"
; ※int64 引数の DLL 値渡しは x64 ランタイム(hsp3_64)のみ対応(x86 は未対応)。; DWORD GetTraceEnableFlags(ULONGLONG TraceHandle)
#uselib "ADVAPI32.dll"
#cfunc global GetTraceEnableFlags "GetTraceEnableFlags" int64
; res = GetTraceEnableFlags(TraceHandle)
; TraceHandle : ULONGLONG -> "int64"import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
advapi32 = windows.NewLazySystemDLL("ADVAPI32.dll")
procGetTraceEnableFlags = advapi32.NewProc("GetTraceEnableFlags")
)
// TraceHandle (ULONGLONG)
r1, _, err := procGetTraceEnableFlags.Call(
uintptr(TraceHandle),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // DWORDfunction GetTraceEnableFlags(
TraceHandle: UInt64 // ULONGLONG
): DWORD; stdcall;
external 'ADVAPI32.dll' name 'GetTraceEnableFlags';result := DllCall("ADVAPI32\GetTraceEnableFlags"
, "Int64", TraceHandle ; ULONGLONG
, "UInt") ; return: DWORD●GetTraceEnableFlags(TraceHandle) = DLL("ADVAPI32.dll", "dword GetTraceEnableFlags(qword)")
# 呼び出し: GetTraceEnableFlags(TraceHandle)
# TraceHandle : ULONGLONG -> "qword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "advapi32" fn GetTraceEnableFlags(
TraceHandle: u64 // ULONGLONG
) callconv(std.os.windows.WINAPI) u32;proc GetTraceEnableFlags(
TraceHandle: uint64 # ULONGLONG
): uint32 {.importc: "GetTraceEnableFlags", stdcall, dynlib: "ADVAPI32.dll".}pragma(lib, "advapi32");
extern(Windows)
uint GetTraceEnableFlags(
ulong TraceHandle // ULONGLONG
);ccall((:GetTraceEnableFlags, "ADVAPI32.dll"), stdcall, UInt32,
(UInt64,),
TraceHandle)
# TraceHandle : ULONGLONG -> UInt64
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
uint32_t GetTraceEnableFlags(
uint64_t TraceHandle);
]]
local advapi32 = ffi.load("advapi32")
-- advapi32.GetTraceEnableFlags(TraceHandle)
-- TraceHandle : ULONGLONG
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('ADVAPI32.dll');
const GetTraceEnableFlags = lib.func('__stdcall', 'GetTraceEnableFlags', 'uint32_t', ['uint64_t']);
// GetTraceEnableFlags(TraceHandle)
// TraceHandle : ULONGLONG -> 'uint64_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("ADVAPI32.dll", {
GetTraceEnableFlags: { parameters: ["u64"], result: "u32" },
});
// lib.symbols.GetTraceEnableFlags(TraceHandle)
// TraceHandle : ULONGLONG -> "u64"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
uint32_t GetTraceEnableFlags(
uint64_t TraceHandle);
C, "ADVAPI32.dll");
// $ffi->GetTraceEnableFlags(TraceHandle);
// TraceHandle : ULONGLONG
// 構造体/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);
int GetTraceEnableFlags(
long TraceHandle // ULONGLONG
);
}@[Link("advapi32")]
lib LibADVAPI32
fun GetTraceEnableFlags = GetTraceEnableFlags(
TraceHandle : UInt64 # ULONGLONG
) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef GetTraceEnableFlagsNative = Uint32 Function(Uint64);
typedef GetTraceEnableFlagsDart = int Function(int);
final GetTraceEnableFlags = DynamicLibrary.open('ADVAPI32.dll')
.lookupFunction<GetTraceEnableFlagsNative, GetTraceEnableFlagsDart>('GetTraceEnableFlags');
// TraceHandle : ULONGLONG -> Uint64
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function GetTraceEnableFlags(
TraceHandle: UInt64 // ULONGLONG
): DWORD; stdcall;
external 'ADVAPI32.dll' name 'GetTraceEnableFlags';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "GetTraceEnableFlags"
c_GetTraceEnableFlags :: Word64 -> IO Word32
-- TraceHandle : ULONGLONG -> Word64
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let gettraceenableflags =
foreign "GetTraceEnableFlags"
(uint64_t @-> returning uint32_t)
(* TraceHandle : ULONGLONG -> uint64_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library advapi32 (t "ADVAPI32.dll"))
(cffi:use-foreign-library advapi32)
(cffi:defcfun ("GetTraceEnableFlags" get-trace-enable-flags :convention :stdcall) :uint32
(trace-handle :uint64)) ; ULONGLONG
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $GetTraceEnableFlags = Win32::API::More->new('ADVAPI32',
'DWORD GetTraceEnableFlags(UINT64 TraceHandle)');
# my $ret = $GetTraceEnableFlags->Call($TraceHandle);
# TraceHandle : ULONGLONG -> UINT64
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。