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

GetTraceLoggerHandle

関数
コンテキストバッファからトレースロガーのハンドルを取得する。
DLLADVAPI32.dll呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

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

ULONGLONG GetTraceLoggerHandle(
    void* Buffer
);

パラメーター

名前方向説明
Buffervoid*in

WNODE_HEADER 構造体へのポインターです。ETW はこの構造体を、プロバイダーの ControlCallback 関数の Buffer パラメーターに渡します。

WNODE_HEADERHistoricalContext メンバーには、セッションのハンドルが格納されます。

戻り値の型: ULONGLONG

公式ドキュメント

RegisterTraceGuids ベースの(「クラシック」)イベントプロバイダーは、

戻り値

関数が成功した場合は、イベントトレースセッションのハンドルを返します。

関数が失敗した場合は、INVALID_HANDLE_VALUE を返します。拡張された エラー情報を取得するには、 GetLastError 関数を呼び出します。

解説(Remarks)

このハンドルは、EnableTrace 関数に渡された enable フラグおよびレベルの値を取得するために、 GetTraceEnableFlags 関数および GetTraceEnableLevel 関数を 呼び出すときに使用します。

Examples

GetTraceLoggerHandle を使用する例については、 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>

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

GetTraceLoggerHandle = ctypes.windll.advapi32.GetTraceLoggerHandle
GetTraceLoggerHandle.restype = ctypes.c_ulonglong
GetTraceLoggerHandle.argtypes = [
    ctypes.POINTER(None),  # Buffer : void*
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ADVAPI32.dll')
GetTraceLoggerHandle = Fiddle::Function.new(
  lib['GetTraceLoggerHandle'],
  [
    Fiddle::TYPE_VOIDP,  # Buffer : void*
  ],
  -Fiddle::TYPE_LONG_LONG)
#[link(name = "advapi32")]
extern "system" {
    fn GetTraceLoggerHandle(
        Buffer: *mut ()  // void*
    ) -> u64;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("ADVAPI32.dll", SetLastError = true)]
public static extern ulong GetTraceLoggerHandle(IntPtr Buffer);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_GetTraceLoggerHandle' -Namespace Win32 -PassThru
# $api::GetTraceLoggerHandle(Buffer)
#uselib "ADVAPI32.dll"
#func global GetTraceLoggerHandle "GetTraceLoggerHandle" sptr
; GetTraceLoggerHandle Buffer   ; 戻り値は stat
; Buffer : void* -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "ADVAPI32.dll"
#cfunc global GetTraceLoggerHandle "GetTraceLoggerHandle" sptr
; res = GetTraceLoggerHandle(Buffer)
; Buffer : void* -> "sptr"
; ULONGLONG GetTraceLoggerHandle(void* Buffer)
#uselib "ADVAPI32.dll"
#cfunc global GetTraceLoggerHandle "GetTraceLoggerHandle" intptr
; res = GetTraceLoggerHandle(Buffer)
; Buffer : void* -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	advapi32 = windows.NewLazySystemDLL("ADVAPI32.dll")
	procGetTraceLoggerHandle = advapi32.NewProc("GetTraceLoggerHandle")
)

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

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

typedef GetTraceLoggerHandleNative = Uint64 Function(Pointer<Void>);
typedef GetTraceLoggerHandleDart = int Function(Pointer<Void>);
final GetTraceLoggerHandle = DynamicLibrary.open('ADVAPI32.dll')
    .lookupFunction<GetTraceLoggerHandleNative, GetTraceLoggerHandleDart>('GetTraceLoggerHandle');
// Buffer : void* -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function GetTraceLoggerHandle(
  Buffer: Pointer   // void*
): UInt64; stdcall;
  external 'ADVAPI32.dll' name 'GetTraceLoggerHandle';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "GetTraceLoggerHandle"
  c_GetTraceLoggerHandle :: Ptr () -> IO Word64
-- Buffer : void* -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let gettraceloggerhandle =
  foreign "GetTraceLoggerHandle"
    ((ptr void) @-> returning uint64_t)
(* Buffer : void* -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library advapi32 (t "ADVAPI32.dll"))
(cffi:use-foreign-library advapi32)

(cffi:defcfun ("GetTraceLoggerHandle" get-trace-logger-handle :convention :stdcall) :uint64
  (buffer :pointer))   ; void*
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $GetTraceLoggerHandle = Win32::API::More->new('ADVAPI32',
    'UINT64 GetTraceLoggerHandle(LPVOID Buffer)');
# my $ret = $GetTraceLoggerHandle->Call($Buffer);
# Buffer : void* -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。