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

TdhGetProperty

関数
イベント内の指定プロパティの値を取得する。
DLLTDH.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

DWORD TdhGetProperty(
    EVENT_RECORD* pEvent,
    DWORD TdhContextCount,
    TDH_CONTEXT* pTdhContext,   // optional
    DWORD PropertyDataCount,
    PROPERTY_DATA_DESCRIPTOR* pPropertyData,
    DWORD BufferSize,
    BYTE* pBuffer
);

パラメーター

名前方向説明
pEventEVENT_RECORD*inプロパティ値を取得する対象のEVENT_RECORD。
TdhContextCountDWORDinpTdhContext配列の要素数。
pTdhContextTDH_CONTEXT*inoptionalデコードに使う追加コンテキスト情報の配列(TDH_CONTEXT)。NULL可。
PropertyDataCountDWORDinpPropertyData配列の要素数。
pPropertyDataPROPERTY_DATA_DESCRIPTOR*in対象プロパティを特定するPROPERTY_DATA_DESCRIPTOR配列。
BufferSizeDWORDin出力バッファpBufferのサイズ(バイト)。
pBufferBYTE*out取得したプロパティ値を受け取る出力バッファ。

戻り値の型: DWORD

各言語での呼び出し定義

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

DWORD TdhGetProperty(
    EVENT_RECORD* pEvent,
    DWORD TdhContextCount,
    TDH_CONTEXT* pTdhContext,   // optional
    DWORD PropertyDataCount,
    PROPERTY_DATA_DESCRIPTOR* pPropertyData,
    DWORD BufferSize,
    BYTE* pBuffer
);
[DllImport("TDH.dll", ExactSpelling = true)]
static extern uint TdhGetProperty(
    IntPtr pEvent,   // EVENT_RECORD*
    uint TdhContextCount,   // DWORD
    IntPtr pTdhContext,   // TDH_CONTEXT* optional
    uint PropertyDataCount,   // DWORD
    IntPtr pPropertyData,   // PROPERTY_DATA_DESCRIPTOR*
    uint BufferSize,   // DWORD
    IntPtr pBuffer   // BYTE* out
);
<DllImport("TDH.dll", ExactSpelling:=True)>
Public Shared Function TdhGetProperty(
    pEvent As IntPtr,   ' EVENT_RECORD*
    TdhContextCount As UInteger,   ' DWORD
    pTdhContext As IntPtr,   ' TDH_CONTEXT* optional
    PropertyDataCount As UInteger,   ' DWORD
    pPropertyData As IntPtr,   ' PROPERTY_DATA_DESCRIPTOR*
    BufferSize As UInteger,   ' DWORD
    pBuffer As IntPtr   ' BYTE* out
) As UInteger
End Function
' pEvent : EVENT_RECORD*
' TdhContextCount : DWORD
' pTdhContext : TDH_CONTEXT* optional
' PropertyDataCount : DWORD
' pPropertyData : PROPERTY_DATA_DESCRIPTOR*
' BufferSize : DWORD
' pBuffer : BYTE* out
Declare PtrSafe Function TdhGetProperty Lib "tdh" ( _
    ByVal pEvent As LongPtr, _
    ByVal TdhContextCount As Long, _
    ByVal pTdhContext As LongPtr, _
    ByVal PropertyDataCount As Long, _
    ByVal pPropertyData As LongPtr, _
    ByVal BufferSize As Long, _
    ByVal pBuffer As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

TdhGetProperty = ctypes.windll.tdh.TdhGetProperty
TdhGetProperty.restype = wintypes.DWORD
TdhGetProperty.argtypes = [
    ctypes.c_void_p,  # pEvent : EVENT_RECORD*
    wintypes.DWORD,  # TdhContextCount : DWORD
    ctypes.c_void_p,  # pTdhContext : TDH_CONTEXT* optional
    wintypes.DWORD,  # PropertyDataCount : DWORD
    ctypes.c_void_p,  # pPropertyData : PROPERTY_DATA_DESCRIPTOR*
    wintypes.DWORD,  # BufferSize : DWORD
    ctypes.POINTER(ctypes.c_ubyte),  # pBuffer : BYTE* out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	tdh = windows.NewLazySystemDLL("TDH.dll")
	procTdhGetProperty = tdh.NewProc("TdhGetProperty")
)

// pEvent (EVENT_RECORD*), TdhContextCount (DWORD), pTdhContext (TDH_CONTEXT* optional), PropertyDataCount (DWORD), pPropertyData (PROPERTY_DATA_DESCRIPTOR*), BufferSize (DWORD), pBuffer (BYTE* out)
r1, _, err := procTdhGetProperty.Call(
	uintptr(pEvent),
	uintptr(TdhContextCount),
	uintptr(pTdhContext),
	uintptr(PropertyDataCount),
	uintptr(pPropertyData),
	uintptr(BufferSize),
	uintptr(pBuffer),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function TdhGetProperty(
  pEvent: Pointer;   // EVENT_RECORD*
  TdhContextCount: DWORD;   // DWORD
  pTdhContext: Pointer;   // TDH_CONTEXT* optional
  PropertyDataCount: DWORD;   // DWORD
  pPropertyData: Pointer;   // PROPERTY_DATA_DESCRIPTOR*
  BufferSize: DWORD;   // DWORD
  pBuffer: Pointer   // BYTE* out
): DWORD; stdcall;
  external 'TDH.dll' name 'TdhGetProperty';
result := DllCall("TDH\TdhGetProperty"
    , "Ptr", pEvent   ; EVENT_RECORD*
    , "UInt", TdhContextCount   ; DWORD
    , "Ptr", pTdhContext   ; TDH_CONTEXT* optional
    , "UInt", PropertyDataCount   ; DWORD
    , "Ptr", pPropertyData   ; PROPERTY_DATA_DESCRIPTOR*
    , "UInt", BufferSize   ; DWORD
    , "Ptr", pBuffer   ; BYTE* out
    , "UInt")   ; return: DWORD
●TdhGetProperty(pEvent, TdhContextCount, pTdhContext, PropertyDataCount, pPropertyData, BufferSize, pBuffer) = DLL("TDH.dll", "dword TdhGetProperty(void*, dword, void*, dword, void*, dword, void*)")
# 呼び出し: TdhGetProperty(pEvent, TdhContextCount, pTdhContext, PropertyDataCount, pPropertyData, BufferSize, pBuffer)
# pEvent : EVENT_RECORD* -> "void*"
# TdhContextCount : DWORD -> "dword"
# pTdhContext : TDH_CONTEXT* optional -> "void*"
# PropertyDataCount : DWORD -> "dword"
# pPropertyData : PROPERTY_DATA_DESCRIPTOR* -> "void*"
# BufferSize : DWORD -> "dword"
# pBuffer : BYTE* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。