ホーム › 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
);

パラメーター

名前	型	方向	説明
pEvent	EVENT_RECORD*	in	EventRecordCallback コールバックに渡されるイベントレコードです。詳細については、EVENT_RECORD 構造体を参照してください。
TdhContextCount	DWORD	in	pTdhContext 内の要素数です。
pTdhContext	TDH_CONTEXT*	inoptional	WPP イベントまたはクラシック ETW イベントの場合のみ指定するコンテキスト値の配列です。それ以外の場合は NULL を指定します。詳細については、TDH_CONTEXT 構造体を参照してください。この配列に重複するコンテキスト型を含めることはできません。
PropertyDataCount	DWORD	in	pPropertyData 内のデータ記述子構造体の数です。
pPropertyData	PROPERTY_DATA_DESCRIPTOR*	in	取得するプロパティを定義する PROPERTY_DATA_DESCRIPTOR 構造体の配列です。プロパティに必要なバッファサイズを取得するために TdhGetPropertySize 関数を呼び出した場合は、同じデータ記述子を使用できます。構造体のメンバーではないプロパティを取得する場合は、単一のデータ記述子を指定できます。構造体のメンバーであるプロパティを取得する場合は、2 つのデータ記述子の配列を指定します(構造体は他の構造体を含んだり参照したりすることはできません)。
BufferSize	DWORD	in	pBuffer バッファのサイズ(バイト単位)です。この値は、TdhGetPropertySize 関数を呼び出したときの pPropertySize パラメーターから取得できます。
pBuffer	BYTE*	out	プロパティデータを受け取る、ユーザーが割り当てたバッファです。

戻り値の型: DWORD

公式ドキュメント

イベントデータからプロパティ値を取得します。

戻り値

成功した場合は ERROR_SUCCESS を返します。それ以外の場合、この関数は以下のいずれかの戻り値(これら以外も含む)を返します。

戻り値	説明
ERROR_NOT_FOUND	イベントのスキーマが見つからないか、指定されたプロパティが見つかりませんでした。
ERROR_INSUFFICIENT_BUFFER	pBuffer バッファが小さすぎます。必要なバッファサイズを取得するには、TdhGetPropertySize を呼び出してください。
ERROR_INVALID_PARAMETER	1 つ以上のパラメーターが無効です。
ERROR_FILE_NOT_FOUND	マニフェスト内の resourceFileName 属性には、プロバイダーバイナリの場所が含まれています。マニフェストを登録すると、その場所がレジストリに書き込まれます。TDH は、登録された場所に基づいてバイナリを見つけることができませんでした。
ERROR_WMI_SERVER_UNAVAILABLE	WMI サービスが利用できません。

解説(Remarks)

イベントが WPP イベントまたはクラシック ETW イベントの場合、イベント情報の解析を補助するために使用されるコンテキスト情報を指定できます。EVENT_HEADER の Flags メンバーに EVENT_HEADER_FLAG_TRACE_MESSAGE フラグが設定されている場合、そのイベントは WPP イベントです(EVENT_RECORD の EventHeader メンバーを参照してください)。EVENT_HEADER_FLAG_CLASSIC_HEADER フラグが設定されている場合、そのイベントはレガシー ETW イベントです。

WPP イベントのプロパティとそのデータ型の一覧については、PROPERTY_DATA_DESCRIPTOR を参照してください。

例

トップレベルのプロパティまたは構造体のメンバーの値を取得するためにこの関数を呼び出す方法を示す例については、Using TdhGetProperty to Consume Event Data を参照してください。

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

各言語での呼び出し定義

// 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 方式にも切替可。#uselib "TDH.dll"
#cfunc global TdhGetProperty "TdhGetProperty" sptr, int, sptr, int, sptr, int, sptr
; res = TdhGetProperty(varptr(pEvent), TdhContextCount, varptr(pTdhContext), PropertyDataCount, varptr(pPropertyData), BufferSize, varptr(pBuffer))
; pEvent : EVENT_RECORD* -> "sptr"
; TdhContextCount : DWORD -> "int"
; pTdhContext : TDH_CONTEXT* optional -> "sptr"
; PropertyDataCount : DWORD -> "int"
; pPropertyData : PROPERTY_DATA_DESCRIPTOR* -> "sptr"
; BufferSize : DWORD -> "int"
; pBuffer : BYTE* out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。