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

GetTraceEnableLevel

関数
指定トレースハンドルで有効なトレースレベルを取得する。
DLLADVAPI32.dll呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

// ADVAPI32.dll
#include <windows.h>

BYTE GetTraceEnableLevel(
    ULONGLONG TraceHandle
);

パラメーター

名前方向説明
TraceHandleULONGLONGinイベントトレースセッションへのハンドル。 GetTraceLoggerHandle 関数を呼び出して取得します。

戻り値の型: BYTE

公式ドキュメント

RegisterTraceGuids ベース(「クラシック」)のイベントプロバイダーは、この値を使用します。

戻り値

コントローラーが EnableTrace 関数を呼び出した際に EnableLevel パラメーターに指定した値を返します。

関数が失敗したのか、それともコントローラーが有効化フラグを 0 に設定したのかを判別するには、 次の手順に従います。

  1. SetLastError 関数を呼び出し、最後のエラーを ERROR_SUCCESS に設定します。
  2. GetTraceEnableLevel 関数を呼び出して有効化レベルを取得します。
  3. 有効化レベルの値が 0 の場合は、 GetLastError 関数を呼び出して最後に判明したエラーを取得します。
  4. 最後に判明したエラーが ERROR_SUCCESS の場合は、コントローラーが有効化レベルを 0 に設定したことを意味します。それ以外の場合は、GetTraceEnableLevel 関数が その最後に判明したエラーで失敗したことを意味します。

解説(Remarks)

プロバイダーはこの値を使用して、生成するイベントの重大度を制御します。 たとえば、情報イベント、警告イベント、エラーイベントのいずれを生成すべきかを判断するために、 プロバイダーはこの値を使用できます。

GetTraceEnableLevel を使用する例については、 Retrieving Event Data Using MOF を参照してください。

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

各言語での呼び出し定義

// ADVAPI32.dll
#include <windows.h>

BYTE GetTraceEnableLevel(
    ULONGLONG TraceHandle
);
[DllImport("ADVAPI32.dll", SetLastError = true, ExactSpelling = true)]
static extern byte GetTraceEnableLevel(
    ulong TraceHandle   // ULONGLONG
);
<DllImport("ADVAPI32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetTraceEnableLevel(
    TraceHandle As ULong   ' ULONGLONG
) As Byte
End Function
' TraceHandle : ULONGLONG
Declare PtrSafe Function GetTraceEnableLevel Lib "advapi32" ( _
    ByVal TraceHandle As LongLong) As Byte
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

GetTraceEnableLevel = ctypes.windll.advapi32.GetTraceEnableLevel
GetTraceEnableLevel.restype = ctypes.c_ubyte
GetTraceEnableLevel.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')
GetTraceEnableLevel = Fiddle::Function.new(
  lib['GetTraceEnableLevel'],
  [
    -Fiddle::TYPE_LONG_LONG,  # TraceHandle : ULONGLONG
  ],
  -Fiddle::TYPE_CHAR)
#[link(name = "advapi32")]
extern "system" {
    fn GetTraceEnableLevel(
        TraceHandle: u64  // ULONGLONG
    ) -> u8;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("ADVAPI32.dll", SetLastError = true)]
public static extern byte GetTraceEnableLevel(ulong TraceHandle);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_GetTraceEnableLevel' -Namespace Win32 -PassThru
# $api::GetTraceEnableLevel(TraceHandle)
#uselib "ADVAPI32.dll"
#func global GetTraceEnableLevel "GetTraceEnableLevel" sptr
; GetTraceEnableLevel TraceHandle   ; 戻り値は stat
; TraceHandle : ULONGLONG -> "sptr"
; ※HSP3.7は int64 引数(64bit値渡し)に非対応です。
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "ADVAPI32.dll"
#cfunc global GetTraceEnableLevel "GetTraceEnableLevel" int64
; res = GetTraceEnableLevel(TraceHandle)
; TraceHandle : ULONGLONG -> "int64"
; ※int64 引数の DLL 値渡しは x64 ランタイム(hsp3_64)のみ対応(x86 は未対応)。
; BYTE GetTraceEnableLevel(ULONGLONG TraceHandle)
#uselib "ADVAPI32.dll"
#cfunc global GetTraceEnableLevel "GetTraceEnableLevel" int64
; res = GetTraceEnableLevel(TraceHandle)
; TraceHandle : ULONGLONG -> "int64"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	advapi32 = windows.NewLazySystemDLL("ADVAPI32.dll")
	procGetTraceEnableLevel = advapi32.NewProc("GetTraceEnableLevel")
)

// TraceHandle (ULONGLONG)
r1, _, err := procGetTraceEnableLevel.Call(
	uintptr(TraceHandle),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BYTE
function GetTraceEnableLevel(
  TraceHandle: UInt64   // ULONGLONG
): Byte; stdcall;
  external 'ADVAPI32.dll' name 'GetTraceEnableLevel';
result := DllCall("ADVAPI32\GetTraceEnableLevel"
    , "Int64", TraceHandle   ; ULONGLONG
    , "UChar")   ; return: BYTE
●GetTraceEnableLevel(TraceHandle) = DLL("ADVAPI32.dll", "byte GetTraceEnableLevel(qword)")
# 呼び出し: GetTraceEnableLevel(TraceHandle)
# TraceHandle : ULONGLONG -> "qword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "advapi32" fn GetTraceEnableLevel(
    TraceHandle: u64 // ULONGLONG
) callconv(std.os.windows.WINAPI) u8;
proc GetTraceEnableLevel(
    TraceHandle: uint64  # ULONGLONG
): uint8 {.importc: "GetTraceEnableLevel", stdcall, dynlib: "ADVAPI32.dll".}
pragma(lib, "advapi32");
extern(Windows)
ubyte GetTraceEnableLevel(
    ulong TraceHandle   // ULONGLONG
);
ccall((:GetTraceEnableLevel, "ADVAPI32.dll"), stdcall, UInt8,
      (UInt64,),
      TraceHandle)
# TraceHandle : ULONGLONG -> UInt64
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint8_t GetTraceEnableLevel(
    uint64_t TraceHandle);
]]
local advapi32 = ffi.load("advapi32")
-- advapi32.GetTraceEnableLevel(TraceHandle)
-- TraceHandle : ULONGLONG
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('ADVAPI32.dll');
const GetTraceEnableLevel = lib.func('__stdcall', 'GetTraceEnableLevel', 'uint8_t', ['uint64_t']);
// GetTraceEnableLevel(TraceHandle)
// TraceHandle : ULONGLONG -> 'uint64_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("ADVAPI32.dll", {
  GetTraceEnableLevel: { parameters: ["u64"], result: "u8" },
});
// lib.symbols.GetTraceEnableLevel(TraceHandle)
// TraceHandle : ULONGLONG -> "u64"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint8_t GetTraceEnableLevel(
    uint64_t TraceHandle);
C, "ADVAPI32.dll");
// $ffi->GetTraceEnableLevel(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);
    byte GetTraceEnableLevel(
        long TraceHandle   // ULONGLONG
    );
}
@[Link("advapi32")]
lib LibADVAPI32
  fun GetTraceEnableLevel = GetTraceEnableLevel(
    TraceHandle : UInt64   # ULONGLONG
  ) : UInt8
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef GetTraceEnableLevelNative = Uint8 Function(Uint64);
typedef GetTraceEnableLevelDart = int Function(int);
final GetTraceEnableLevel = DynamicLibrary.open('ADVAPI32.dll')
    .lookupFunction<GetTraceEnableLevelNative, GetTraceEnableLevelDart>('GetTraceEnableLevel');
// TraceHandle : ULONGLONG -> Uint64
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function GetTraceEnableLevel(
  TraceHandle: UInt64   // ULONGLONG
): Byte; stdcall;
  external 'ADVAPI32.dll' name 'GetTraceEnableLevel';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "GetTraceEnableLevel"
  c_GetTraceEnableLevel :: Word64 -> IO Word8
-- TraceHandle : ULONGLONG -> Word64
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let gettraceenablelevel =
  foreign "GetTraceEnableLevel"
    (uint64_t @-> returning uint8_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 ("GetTraceEnableLevel" get-trace-enable-level :convention :stdcall) :uint8
  (trace-handle :uint64))   ; ULONGLONG
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $GetTraceEnableLevel = Win32::API::More->new('ADVAPI32',
    'BYTE GetTraceEnableLevel(UINT64 TraceHandle)');
# my $ret = $GetTraceEnableLevel->Call($TraceHandle);
# TraceHandle : ULONGLONG -> UINT64
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。