ホーム › System.Diagnostics.Etw › TdhGetEventInformation

TdhGetEventInformation

関数

イベントのメタデータやスキーマ情報を取得する。

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

シグネチャ

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

DWORD TdhGetEventInformation(
    EVENT_RECORD* Event,
    DWORD TdhContextCount,
    TDH_CONTEXT* TdhContext,   // optional
    TRACE_EVENT_INFO* Buffer,   // optional
    DWORD* BufferSize
);

パラメーター

名前	型	方向	説明
Event	EVENT_RECORD*	in	EventRecordCallback コールバックに渡されるイベントレコードです。詳細については、EVENT_RECORD 構造体を参照してください。
TdhContextCount	DWORD	in	pTdhContext 内の要素数です。
TdhContext	TDH_CONTEXT*	inoptional	WPP イベントまたはクラシック ETW イベントの場合にのみ指定するコンテキスト値の配列です。それ以外の場合は NULL を指定します。詳細については、TDH_CONTEXT 構造体を参照してください。この配列に重複したコンテキスト型を含めることはできません。
Buffer	TRACE_EVENT_INFO*	outoptional	イベント情報を受け取るための、ユーザーが割り当てたバッファーです。詳細については、TRACE_EVENT_INFO 構造体を参照してください。
BufferSize	DWORD*	inout	pBuffer バッファーのサイズ(バイト単位)です。関数が成功した場合、このパラメーターには使用されたバッファーのサイズが格納されます。バッファーが小さすぎる場合、関数は ERROR_INSUFFICIENT_BUFFER を返し、このパラメーターに必要なバッファーサイズを設定します。入力時にバッファーサイズがゼロの場合、バッファーにはデータが返されず、このパラメーターに必要なバッファーサイズが格納されます。

戻り値の型: DWORD

公式ドキュメント

イベントに関するメタデータを取得します。

戻り値

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

戻り値	説明
ERROR_INSUFFICIENT_BUFFER	pBuffer バッファーのサイズが小さすぎます。pBufferSize に設定された必要なバッファーサイズを使用して、新しいバッファーを割り当ててください。
ERROR_NOT_FOUND	イベントのスキーマが見つかりませんでした。
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 TdhFormatProperty 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 TdhGetEventInformation(
    EVENT_RECORD* Event,
    DWORD TdhContextCount,
    TDH_CONTEXT* TdhContext,   // optional
    TRACE_EVENT_INFO* Buffer,   // optional
    DWORD* BufferSize
);

[DllImport("TDH.dll", ExactSpelling = true)]
static extern uint TdhGetEventInformation(
    IntPtr Event,   // EVENT_RECORD*
    uint TdhContextCount,   // DWORD
    IntPtr TdhContext,   // TDH_CONTEXT* optional
    IntPtr Buffer,   // TRACE_EVENT_INFO* optional, out
    ref uint BufferSize   // DWORD* in/out
);

<DllImport("TDH.dll", ExactSpelling:=True)>
Public Shared Function TdhGetEventInformation(
    [Event] As IntPtr,   ' EVENT_RECORD*
    TdhContextCount As UInteger,   ' DWORD
    TdhContext As IntPtr,   ' TDH_CONTEXT* optional
    Buffer As IntPtr,   ' TRACE_EVENT_INFO* optional, out
    ByRef BufferSize As UInteger   ' DWORD* in/out
) As UInteger
End Function

' Event : EVENT_RECORD*
' TdhContextCount : DWORD
' TdhContext : TDH_CONTEXT* optional
' Buffer : TRACE_EVENT_INFO* optional, out
' BufferSize : DWORD* in/out
Declare PtrSafe Function TdhGetEventInformation Lib "tdh" ( _
    ByVal Event As LongPtr, _
    ByVal TdhContextCount As Long, _
    ByVal TdhContext As LongPtr, _
    ByVal Buffer As LongPtr, _
    ByRef BufferSize As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

TdhGetEventInformation = ctypes.windll.tdh.TdhGetEventInformation
TdhGetEventInformation.restype = wintypes.DWORD
TdhGetEventInformation.argtypes = [
    ctypes.c_void_p,  # Event : EVENT_RECORD*
    wintypes.DWORD,  # TdhContextCount : DWORD
    ctypes.c_void_p,  # TdhContext : TDH_CONTEXT* optional
    ctypes.c_void_p,  # Buffer : TRACE_EVENT_INFO* optional, out
    ctypes.POINTER(wintypes.DWORD),  # BufferSize : DWORD* in/out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('TDH.dll')
TdhGetEventInformation = Fiddle::Function.new(
  lib['TdhGetEventInformation'],
  [
    Fiddle::TYPE_VOIDP,  # Event : EVENT_RECORD*
    -Fiddle::TYPE_INT,  # TdhContextCount : DWORD
    Fiddle::TYPE_VOIDP,  # TdhContext : TDH_CONTEXT* optional
    Fiddle::TYPE_VOIDP,  # Buffer : TRACE_EVENT_INFO* optional, out
    Fiddle::TYPE_VOIDP,  # BufferSize : DWORD* in/out
  ],
  -Fiddle::TYPE_INT)

#[link(name = "tdh")]
extern "system" {
    fn TdhGetEventInformation(
        Event: *mut EVENT_RECORD,  // EVENT_RECORD*
        TdhContextCount: u32,  // DWORD
        TdhContext: *mut TDH_CONTEXT,  // TDH_CONTEXT* optional
        Buffer: *mut TRACE_EVENT_INFO,  // TRACE_EVENT_INFO* optional, out
        BufferSize: *mut u32  // DWORD* in/out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("TDH.dll")]
public static extern uint TdhGetEventInformation(IntPtr Event, uint TdhContextCount, IntPtr TdhContext, IntPtr Buffer, ref uint BufferSize);
"@
$api = Add-Type -MemberDefinition $sig -Name 'TDH_TdhGetEventInformation' -Namespace Win32 -PassThru
# $api::TdhGetEventInformation(Event, TdhContextCount, TdhContext, Buffer, BufferSize)

#uselib "TDH.dll"
#func global TdhGetEventInformation "TdhGetEventInformation" sptr, sptr, sptr, sptr, sptr
; TdhGetEventInformation varptr(Event), TdhContextCount, varptr(TdhContext), varptr(Buffer), varptr(BufferSize)   ; 戻り値は stat
; Event : EVENT_RECORD* -> "sptr"
; TdhContextCount : DWORD -> "sptr"
; TdhContext : TDH_CONTEXT* optional -> "sptr"
; Buffer : TRACE_EVENT_INFO* optional, out -> "sptr"
; BufferSize : DWORD* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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