ホーム › System.Diagnostics.Etw › TdhGetPropertySize

TdhGetPropertySize

関数

イベント内の指定プロパティのデータサイズを取得する。

DLLTDH.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

DWORD TdhGetPropertySize(
    EVENT_RECORD* pEvent,
    DWORD TdhContextCount,
    TDH_CONTEXT* pTdhContext,   // optional
    DWORD PropertyDataCount,
    PROPERTY_DATA_DESCRIPTOR* pPropertyData,
    DWORD* pPropertySize
);

パラメーター

名前	型	方向	説明
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 構造体の配列です。この同じ配列を TdhGetProperty 関数に渡してプロパティデータを取得できます。構造体のメンバーではないプロパティのサイズを取得する場合は、単一のデータ記述子を指定できます。構造体のメンバーであるプロパティのサイズを取得する場合は、2 つのデータ記述子からなる配列を指定します(構造体が他の構造体を含んだり参照したりすることはできません)。このパラメーターの指定方法の詳細については、以下のサンプルコードを参照してください。
pPropertySize	DWORD*	out	プロパティのサイズ(バイト単位)です。この値を使用して、TdhGetProperty 関数の pBuffer パラメーターに渡すバッファーを割り当てます。

戻り値の型: DWORD

公式ドキュメント

イベントデータ内の 1 つ以上のプロパティ値のサイズを取得します。

戻り値

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

戻り値コード	説明
ERROR_NOT_FOUND	イベントのスキーマが見つからなかったか、指定されたマップが見つかりませんでした。イベントの定義に MOF クラスを使用した場合、TDH は WMI リポジトリ内でスキーマを検索します。イベントの定義にマニフェストを使用した場合、TDH はプロバイダーのリソース内を検索します。マニフェストを使用する場合、provider 要素の resourceFileName 属性が、TDH がリソースを検索する場所を定義します。
ERROR_INVALID_PARAMETER	1 つ以上のパラメーターが無効です。
ERROR_FILE_NOT_FOUND	マニフェスト内の resourceFileName 属性には、プロバイダーバイナリの場所が含まれています。マニフェストを登録すると、その場所がレジストリに書き込まれます。TDH は登録された場所に基づいてバイナリを見つけることができませんでした。
ERROR_WMI_SERVER_UNAVAILABLE	WMI サービスが利用できません。

解説(Remarks)

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

例

この関数の呼び出し方法を示す例については、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 TdhGetPropertySize(
    EVENT_RECORD* pEvent,
    DWORD TdhContextCount,
    TDH_CONTEXT* pTdhContext,   // optional
    DWORD PropertyDataCount,
    PROPERTY_DATA_DESCRIPTOR* pPropertyData,
    DWORD* pPropertySize
);

[DllImport("TDH.dll", ExactSpelling = true)]
static extern uint TdhGetPropertySize(
    IntPtr pEvent,   // EVENT_RECORD*
    uint TdhContextCount,   // DWORD
    IntPtr pTdhContext,   // TDH_CONTEXT* optional
    uint PropertyDataCount,   // DWORD
    IntPtr pPropertyData,   // PROPERTY_DATA_DESCRIPTOR*
    out uint pPropertySize   // DWORD* out
);

<DllImport("TDH.dll", ExactSpelling:=True)>
Public Shared Function TdhGetPropertySize(
    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*
    <Out> ByRef pPropertySize As UInteger   ' DWORD* out
) As UInteger
End Function

' pEvent : EVENT_RECORD*
' TdhContextCount : DWORD
' pTdhContext : TDH_CONTEXT* optional
' PropertyDataCount : DWORD
' pPropertyData : PROPERTY_DATA_DESCRIPTOR*
' pPropertySize : DWORD* out
Declare PtrSafe Function TdhGetPropertySize Lib "tdh" ( _
    ByVal pEvent As LongPtr, _
    ByVal TdhContextCount As Long, _
    ByVal pTdhContext As LongPtr, _
    ByVal PropertyDataCount As Long, _
    ByVal pPropertyData As LongPtr, _
    ByRef pPropertySize As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

TdhGetPropertySize = ctypes.windll.tdh.TdhGetPropertySize
TdhGetPropertySize.restype = wintypes.DWORD
TdhGetPropertySize.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*
    ctypes.POINTER(wintypes.DWORD),  # pPropertySize : DWORD* out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('TDH.dll')
TdhGetPropertySize = Fiddle::Function.new(
  lib['TdhGetPropertySize'],
  [
    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_VOIDP,  # pPropertySize : DWORD* out
  ],
  -Fiddle::TYPE_INT)

#[link(name = "tdh")]
extern "system" {
    fn TdhGetPropertySize(
        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*
        pPropertySize: *mut u32  // DWORD* out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("TDH.dll")]
public static extern uint TdhGetPropertySize(IntPtr pEvent, uint TdhContextCount, IntPtr pTdhContext, uint PropertyDataCount, IntPtr pPropertyData, out uint pPropertySize);
"@
$api = Add-Type -MemberDefinition $sig -Name 'TDH_TdhGetPropertySize' -Namespace Win32 -PassThru
# $api::TdhGetPropertySize(pEvent, TdhContextCount, pTdhContext, PropertyDataCount, pPropertyData, pPropertySize)

#uselib "TDH.dll"
#func global TdhGetPropertySize "TdhGetPropertySize" sptr, sptr, sptr, sptr, sptr, sptr
; TdhGetPropertySize varptr(pEvent), TdhContextCount, varptr(pTdhContext), PropertyDataCount, varptr(pPropertyData), varptr(pPropertySize)   ; 戻り値は stat
; pEvent : EVENT_RECORD* -> "sptr"
; TdhContextCount : DWORD -> "sptr"
; pTdhContext : TDH_CONTEXT* optional -> "sptr"
; PropertyDataCount : DWORD -> "sptr"
; pPropertyData : PROPERTY_DATA_DESCRIPTOR* -> "sptr"
; pPropertySize : DWORD* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "TDH.dll"
#cfunc global TdhGetPropertySize "TdhGetPropertySize" var, int, var, int, var, var
; res = TdhGetPropertySize(pEvent, TdhContextCount, pTdhContext, PropertyDataCount, pPropertyData, pPropertySize)
; pEvent : EVENT_RECORD* -> "var"
; TdhContextCount : DWORD -> "int"
; pTdhContext : TDH_CONTEXT* optional -> "var"
; PropertyDataCount : DWORD -> "int"
; pPropertyData : PROPERTY_DATA_DESCRIPTOR* -> "var"
; pPropertySize : DWORD* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "TDH.dll"
#cfunc global TdhGetPropertySize "TdhGetPropertySize" sptr, int, sptr, int, sptr, sptr
; res = TdhGetPropertySize(varptr(pEvent), TdhContextCount, varptr(pTdhContext), PropertyDataCount, varptr(pPropertyData), varptr(pPropertySize))
; pEvent : EVENT_RECORD* -> "sptr"
; TdhContextCount : DWORD -> "int"
; pTdhContext : TDH_CONTEXT* optional -> "sptr"
; PropertyDataCount : DWORD -> "int"
; pPropertyData : PROPERTY_DATA_DESCRIPTOR* -> "sptr"
; pPropertySize : DWORD* out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。