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

パラメーター

名前	型	方向	説明
Handle	TDH_HANDLE	in	有効なデコードハンドル。
EventRecord	EVENT_RECORD*	in	EventRecordCallback コールバックに渡されるイベントレコード。
PropertyName	LPWSTR	in	取得するプロパティの名前。指定可能な値の一覧については、PROPERTY_DATA_DESCRIPTOR を参照してください。
BufferSize	DWORD*	inout	Buffer パラメーターのサイズ (バイト単位)。
Buffer	BYTE*	out	プロパティデータを受け取る、ユーザーが割り当てたバッファー。

戻り値の型: DWORD

公式ドキュメント

WPP メッセージに関連付けられた特定のプロパティを取得します。

戻り値

Type: ULONG

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

戻りコード	説明
ERROR_NOT_FOUND	指定されたプロパティが見つかりませんでした。
ERROR_INSUFFICIENT_BUFFER	BufferSize が小さすぎます。必要なバッファーサイズを取得するには、TdhGetWppProperty を 2 回呼び出します。最初は null バッファーとバッファーサイズを受け取るポインターを指定して呼び出し、次に正しいサイズのバッファーを指定して呼び出します。
ERROR_INVALID_PARAMETER	1 つ以上のパラメーターが正しくありません。このエラーは、Handle、EventRecord、PropertyName、または Buffer パラメーターが NULL である場合に返されます。

解説(Remarks)

プロパティ名を指定せずにデコード済みのイベントメッセージのみを取得するには、TdhGetWppMessage を呼び出してください。

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

各言語での呼び出し定義

// 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 方式にも切替可。#uselib "TDH.dll"
#cfunc global TdhGetWppProperty "TdhGetWppProperty" sptr, sptr, wstr, sptr, sptr
; res = TdhGetWppProperty(Handle, varptr(EventRecord), PropertyName, varptr(BufferSize), varptr(Buffer))
; Handle : TDH_HANDLE -> "sptr"
; EventRecord : EVENT_RECORD* -> "sptr"
; PropertyName : LPWSTR -> "wstr"
; BufferSize : DWORD* in/out -> "sptr"
; Buffer : BYTE* out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。