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

TdhGetWppProperty

関数
WPPイベントから指定名のプロパティ値を取得する。
DLLtdh.dll呼出規約winapi対応OSwindows8.0

シグネチャ

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

DWORD TdhGetWppProperty(
    TDH_HANDLE Handle,
    EVENT_RECORD* EventRecord,
    LPWSTR PropertyName,
    DWORD* BufferSize,
    BYTE* Buffer
);

パラメーター

名前方向説明
HandleTDH_HANDLEinTdhOpenDecodingHandleで取得したデコードハンドル。
EventRecordEVENT_RECORD*inプロパティを取り出す対象のWPPイベントを表すEVENT_RECORDへのポインタ。
PropertyNameLPWSTRin取得するプロパティ名を指すワイド文字列。
BufferSizeDWORD*inoutBufferのサイズ(バイト)を渡し、必要サイズや書込みサイズを返すDWORDへのポインタ。
BufferBYTE*outプロパティ値を受け取る出力バッファ。サイズ問い合わせ時はNULL可。

戻り値の型: DWORD

各言語での呼び出し定義

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

DWORD TdhGetWppProperty(
    TDH_HANDLE Handle,
    EVENT_RECORD* EventRecord,
    LPWSTR PropertyName,
    DWORD* BufferSize,
    BYTE* Buffer
);
[DllImport("tdh.dll", ExactSpelling = true)]
static extern uint TdhGetWppProperty(
    IntPtr Handle,   // TDH_HANDLE
    IntPtr EventRecord,   // EVENT_RECORD*
    [MarshalAs(UnmanagedType.LPWStr)] string PropertyName,   // LPWSTR
    ref uint BufferSize,   // DWORD* in/out
    IntPtr Buffer   // BYTE* out
);
<DllImport("tdh.dll", ExactSpelling:=True)>
Public Shared Function TdhGetWppProperty(
    Handle As IntPtr,   ' TDH_HANDLE
    EventRecord As IntPtr,   ' EVENT_RECORD*
    <MarshalAs(UnmanagedType.LPWStr)> PropertyName As String,   ' LPWSTR
    ByRef BufferSize As UInteger,   ' DWORD* in/out
    Buffer As IntPtr   ' BYTE* out
) As UInteger
End Function
' Handle : TDH_HANDLE
' EventRecord : EVENT_RECORD*
' PropertyName : LPWSTR
' BufferSize : DWORD* in/out
' Buffer : BYTE* out
Declare PtrSafe Function TdhGetWppProperty Lib "tdh" ( _
    ByVal Handle As LongPtr, _
    ByVal EventRecord As LongPtr, _
    ByVal PropertyName As LongPtr, _
    ByRef BufferSize As Long, _
    ByVal Buffer As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

TdhGetWppProperty = ctypes.windll.tdh.TdhGetWppProperty
TdhGetWppProperty.restype = wintypes.DWORD
TdhGetWppProperty.argtypes = [
    ctypes.c_ssize_t,  # Handle : TDH_HANDLE
    ctypes.c_void_p,  # EventRecord : EVENT_RECORD*
    wintypes.LPCWSTR,  # PropertyName : LPWSTR
    ctypes.POINTER(wintypes.DWORD),  # BufferSize : DWORD* in/out
    ctypes.POINTER(ctypes.c_ubyte),  # Buffer : BYTE* out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	tdh = windows.NewLazySystemDLL("tdh.dll")
	procTdhGetWppProperty = tdh.NewProc("TdhGetWppProperty")
)

// Handle (TDH_HANDLE), EventRecord (EVENT_RECORD*), PropertyName (LPWSTR), BufferSize (DWORD* in/out), Buffer (BYTE* out)
r1, _, err := procTdhGetWppProperty.Call(
	uintptr(Handle),
	uintptr(EventRecord),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(PropertyName))),
	uintptr(BufferSize),
	uintptr(Buffer),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function TdhGetWppProperty(
  Handle: NativeInt;   // TDH_HANDLE
  EventRecord: Pointer;   // EVENT_RECORD*
  PropertyName: PWideChar;   // LPWSTR
  BufferSize: Pointer;   // DWORD* in/out
  Buffer: Pointer   // BYTE* out
): DWORD; stdcall;
  external 'tdh.dll' name 'TdhGetWppProperty';
result := DllCall("tdh\TdhGetWppProperty"
    , "Ptr", Handle   ; TDH_HANDLE
    , "Ptr", EventRecord   ; EVENT_RECORD*
    , "WStr", PropertyName   ; LPWSTR
    , "Ptr", BufferSize   ; DWORD* in/out
    , "Ptr", Buffer   ; BYTE* out
    , "UInt")   ; return: DWORD
●TdhGetWppProperty(Handle, EventRecord, PropertyName, BufferSize, Buffer) = DLL("tdh.dll", "dword TdhGetWppProperty(int, void*, char*, void*, void*)")
# 呼び出し: TdhGetWppProperty(Handle, EventRecord, PropertyName, BufferSize, Buffer)
# Handle : TDH_HANDLE -> "int"
# EventRecord : EVENT_RECORD* -> "void*"
# PropertyName : LPWSTR -> "char*"
# BufferSize : DWORD* in/out -> "void*"
# Buffer : BYTE* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。