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

TdhOpenDecodingHandle

関数
イベントデコード用のハンドルを開く。
DLLTDH.dll呼出規約winapi対応OSwindows8.0

シグネチャ

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

DWORD TdhOpenDecodingHandle(
    TDH_HANDLE* Handle
);

パラメーター

名前方向説明
HandleTDH_HANDLE*out有効なデコードハンドルです。

戻り値の型: DWORD

公式ドキュメント

デコードハンドルを開きます。

戻り値

型: ULONG

成功した場合は ERROR_SUCCESS を返します。それ以外の場合、この関数は他のコードに加えて次のいずれかの戻りコードを返します。

戻りコード 説明
ERROR_INVALID_PARAMETER
パラメーターが正しくありません。このエラーは、Handle パラメーターが NULL の場合に返されます。
ERROR_NOT_ENOUGH_MEMORY
メモリの割り当てに失敗しました。

解説(Remarks)

返されたハンドルを解放するには、TdhCloseDecodingHandle を呼び出します。

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

各言語での呼び出し定義

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

DWORD TdhOpenDecodingHandle(
    TDH_HANDLE* Handle
);
[DllImport("TDH.dll", ExactSpelling = true)]
static extern uint TdhOpenDecodingHandle(
    out IntPtr Handle   // TDH_HANDLE* out
);
<DllImport("TDH.dll", ExactSpelling:=True)>
Public Shared Function TdhOpenDecodingHandle(
    <Out> ByRef Handle As IntPtr   ' TDH_HANDLE* out
) As UInteger
End Function
' Handle : TDH_HANDLE* out
Declare PtrSafe Function TdhOpenDecodingHandle Lib "tdh" ( _
    ByRef Handle As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

TdhOpenDecodingHandle = ctypes.windll.tdh.TdhOpenDecodingHandle
TdhOpenDecodingHandle.restype = wintypes.DWORD
TdhOpenDecodingHandle.argtypes = [
    ctypes.c_void_p,  # Handle : TDH_HANDLE* out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('TDH.dll')
TdhOpenDecodingHandle = Fiddle::Function.new(
  lib['TdhOpenDecodingHandle'],
  [
    Fiddle::TYPE_VOIDP,  # Handle : TDH_HANDLE* out
  ],
  -Fiddle::TYPE_INT)
#[link(name = "tdh")]
extern "system" {
    fn TdhOpenDecodingHandle(
        Handle: *mut isize  // TDH_HANDLE* out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("TDH.dll")]
public static extern uint TdhOpenDecodingHandle(out IntPtr Handle);
"@
$api = Add-Type -MemberDefinition $sig -Name 'TDH_TdhOpenDecodingHandle' -Namespace Win32 -PassThru
# $api::TdhOpenDecodingHandle(Handle)
#uselib "TDH.dll"
#func global TdhOpenDecodingHandle "TdhOpenDecodingHandle" sptr
; TdhOpenDecodingHandle varptr(Handle)   ; 戻り値は stat
; Handle : TDH_HANDLE* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "TDH.dll"
#cfunc global TdhOpenDecodingHandle "TdhOpenDecodingHandle" var
; res = TdhOpenDecodingHandle(Handle)
; Handle : TDH_HANDLE* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; DWORD TdhOpenDecodingHandle(TDH_HANDLE* Handle)
#uselib "TDH.dll"
#cfunc global TdhOpenDecodingHandle "TdhOpenDecodingHandle" var
; res = TdhOpenDecodingHandle(Handle)
; Handle : TDH_HANDLE* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	tdh = windows.NewLazySystemDLL("TDH.dll")
	procTdhOpenDecodingHandle = tdh.NewProc("TdhOpenDecodingHandle")
)

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

extern "tdh" fn TdhOpenDecodingHandle(
    Handle: [*c]isize // TDH_HANDLE* out
) callconv(std.os.windows.WINAPI) u32;
proc TdhOpenDecodingHandle(
    Handle: ptr int  # TDH_HANDLE* out
): uint32 {.importc: "TdhOpenDecodingHandle", stdcall, dynlib: "TDH.dll".}
pragma(lib, "tdh");
extern(Windows)
uint TdhOpenDecodingHandle(
    ptrdiff_t* Handle   // TDH_HANDLE* out
);
ccall((:TdhOpenDecodingHandle, "TDH.dll"), stdcall, UInt32,
      (Ptr{Int},),
      Handle)
# Handle : TDH_HANDLE* out -> Ptr{Int}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t TdhOpenDecodingHandle(
    intptr_t* Handle);
]]
local tdh = ffi.load("tdh")
-- tdh.TdhOpenDecodingHandle(Handle)
-- Handle : TDH_HANDLE* out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('TDH.dll');
const TdhOpenDecodingHandle = lib.func('__stdcall', 'TdhOpenDecodingHandle', 'uint32_t', ['intptr_t *']);
// TdhOpenDecodingHandle(Handle)
// Handle : TDH_HANDLE* out -> 'intptr_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("TDH.dll", {
  TdhOpenDecodingHandle: { parameters: ["pointer"], result: "u32" },
});
// lib.symbols.TdhOpenDecodingHandle(Handle)
// Handle : TDH_HANDLE* out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t TdhOpenDecodingHandle(
    intptr_t* Handle);
C, "TDH.dll");
// $ffi->TdhOpenDecodingHandle(Handle);
// Handle : TDH_HANDLE* 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 Tdh extends StdCallLibrary {
    Tdh INSTANCE = Native.load("tdh", Tdh.class);
    int TdhOpenDecodingHandle(
        LongByReference Handle   // TDH_HANDLE* out
    );
}
@[Link("tdh")]
lib LibTDH
  fun TdhOpenDecodingHandle = TdhOpenDecodingHandle(
    Handle : LibC::SSizeT*   # TDH_HANDLE* out
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef TdhOpenDecodingHandleNative = Uint32 Function(Pointer<IntPtr>);
typedef TdhOpenDecodingHandleDart = int Function(Pointer<IntPtr>);
final TdhOpenDecodingHandle = DynamicLibrary.open('TDH.dll')
    .lookupFunction<TdhOpenDecodingHandleNative, TdhOpenDecodingHandleDart>('TdhOpenDecodingHandle');
// Handle : TDH_HANDLE* out -> Pointer<IntPtr>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function TdhOpenDecodingHandle(
  Handle: Pointer   // TDH_HANDLE* out
): DWORD; stdcall;
  external 'TDH.dll' name 'TdhOpenDecodingHandle';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "TdhOpenDecodingHandle"
  c_TdhOpenDecodingHandle :: Ptr CIntPtr -> IO Word32
-- Handle : TDH_HANDLE* out -> Ptr CIntPtr
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let tdhopendecodinghandle =
  foreign "TdhOpenDecodingHandle"
    ((ptr intptr_t) @-> returning uint32_t)
(* Handle : TDH_HANDLE* out -> (ptr intptr_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library tdh (t "TDH.dll"))
(cffi:use-foreign-library tdh)

(cffi:defcfun ("TdhOpenDecodingHandle" tdh-open-decoding-handle :convention :stdcall) :uint32
  (handle :pointer))   ; TDH_HANDLE* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $TdhOpenDecodingHandle = Win32::API::More->new('TDH',
    'DWORD TdhOpenDecodingHandle(LPVOID Handle)');
# my $ret = $TdhOpenDecodingHandle->Call($Handle);
# Handle : TDH_HANDLE* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目