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

TdhGetWppMessage

関数
WPPイベントから書式化されたメッセージを取得する。
DLLTDH.dll呼出規約winapi対応OSwindows8.0

シグネチャ

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

DWORD TdhGetWppMessage(
    TDH_HANDLE Handle,
    EVENT_RECORD* EventRecord,
    DWORD* BufferSize,
    BYTE* Buffer
);

パラメーター

名前方向説明
HandleTDH_HANDLEin有効なデコードハンドルです。
EventRecordEVENT_RECORD*inEventRecordCallback コールバックに渡されたイベントレコードです。
BufferSizeDWORD*inoutBuffer パラメーターのサイズ(バイト単位)です。
BufferBYTE*outプロパティデータを受け取る、ユーザーが割り当てたバッファーです。

戻り値の型: DWORD

公式ドキュメント

EVENT_RECORD 構造体に埋め込まれた、書式設定済みの WPP メッセージを取得します。

戻り値

型: ULONG

成功した場合は ERROR_SUCCESS を返します。それ以外の場合、この関数はその他のコードに加えて、次のいずれかのリターンコードを返します。

リターンコード 説明
ERROR_NOT_FOUND
指定されたプロパティが見つかりませんでした。
ERROR_INSUFFICIENT_BUFFER
BufferSize が小さすぎます。必要なバッファーサイズを取得するには、TdhGetPropertySize を呼び出してください。
ERROR_INVALID_PARAMETER
1 つ以上のパラメーターが無効です。

解説(Remarks)

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

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

各言語での呼び出し定義

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

DWORD TdhGetWppMessage(
    TDH_HANDLE Handle,
    EVENT_RECORD* EventRecord,
    DWORD* BufferSize,
    BYTE* Buffer
);
[DllImport("TDH.dll", ExactSpelling = true)]
static extern uint TdhGetWppMessage(
    IntPtr Handle,   // TDH_HANDLE
    IntPtr EventRecord,   // EVENT_RECORD*
    ref uint BufferSize,   // DWORD* in/out
    IntPtr Buffer   // BYTE* out
);
<DllImport("TDH.dll", ExactSpelling:=True)>
Public Shared Function TdhGetWppMessage(
    Handle As IntPtr,   ' TDH_HANDLE
    EventRecord As IntPtr,   ' EVENT_RECORD*
    ByRef BufferSize As UInteger,   ' DWORD* in/out
    Buffer As IntPtr   ' BYTE* out
) As UInteger
End Function
' Handle : TDH_HANDLE
' EventRecord : EVENT_RECORD*
' BufferSize : DWORD* in/out
' Buffer : BYTE* out
Declare PtrSafe Function TdhGetWppMessage Lib "tdh" ( _
    ByVal Handle As LongPtr, _
    ByVal EventRecord 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

TdhGetWppMessage = ctypes.windll.tdh.TdhGetWppMessage
TdhGetWppMessage.restype = wintypes.DWORD
TdhGetWppMessage.argtypes = [
    ctypes.c_ssize_t,  # Handle : TDH_HANDLE
    ctypes.c_void_p,  # EventRecord : EVENT_RECORD*
    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')
TdhGetWppMessage = Fiddle::Function.new(
  lib['TdhGetWppMessage'],
  [
    Fiddle::TYPE_INTPTR_T,  # Handle : TDH_HANDLE
    Fiddle::TYPE_VOIDP,  # EventRecord : EVENT_RECORD*
    Fiddle::TYPE_VOIDP,  # BufferSize : DWORD* in/out
    Fiddle::TYPE_VOIDP,  # Buffer : BYTE* out
  ],
  -Fiddle::TYPE_INT)
#[link(name = "tdh")]
extern "system" {
    fn TdhGetWppMessage(
        Handle: isize,  // TDH_HANDLE
        EventRecord: *mut EVENT_RECORD,  // EVENT_RECORD*
        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 TdhGetWppMessage(IntPtr Handle, IntPtr EventRecord, ref uint BufferSize, IntPtr Buffer);
"@
$api = Add-Type -MemberDefinition $sig -Name 'TDH_TdhGetWppMessage' -Namespace Win32 -PassThru
# $api::TdhGetWppMessage(Handle, EventRecord, BufferSize, Buffer)
#uselib "TDH.dll"
#func global TdhGetWppMessage "TdhGetWppMessage" sptr, sptr, sptr, sptr
; TdhGetWppMessage Handle, varptr(EventRecord), varptr(BufferSize), varptr(Buffer)   ; 戻り値は stat
; Handle : TDH_HANDLE -> "sptr"
; EventRecord : EVENT_RECORD* -> "sptr"
; BufferSize : DWORD* in/out -> "sptr"
; Buffer : BYTE* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "TDH.dll"
#cfunc global TdhGetWppMessage "TdhGetWppMessage" sptr, var, var, var
; res = TdhGetWppMessage(Handle, EventRecord, BufferSize, Buffer)
; Handle : TDH_HANDLE -> "sptr"
; EventRecord : EVENT_RECORD* -> "var"
; BufferSize : DWORD* in/out -> "var"
; Buffer : BYTE* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; DWORD TdhGetWppMessage(TDH_HANDLE Handle, EVENT_RECORD* EventRecord, DWORD* BufferSize, BYTE* Buffer)
#uselib "TDH.dll"
#cfunc global TdhGetWppMessage "TdhGetWppMessage" intptr, var, var, var
; res = TdhGetWppMessage(Handle, EventRecord, BufferSize, Buffer)
; Handle : TDH_HANDLE -> "intptr"
; EventRecord : EVENT_RECORD* -> "var"
; BufferSize : DWORD* in/out -> "var"
; Buffer : BYTE* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	tdh = windows.NewLazySystemDLL("TDH.dll")
	procTdhGetWppMessage = tdh.NewProc("TdhGetWppMessage")
)

// Handle (TDH_HANDLE), EventRecord (EVENT_RECORD*), BufferSize (DWORD* in/out), Buffer (BYTE* out)
r1, _, err := procTdhGetWppMessage.Call(
	uintptr(Handle),
	uintptr(EventRecord),
	uintptr(BufferSize),
	uintptr(Buffer),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function TdhGetWppMessage(
  Handle: NativeInt;   // TDH_HANDLE
  EventRecord: Pointer;   // EVENT_RECORD*
  BufferSize: Pointer;   // DWORD* in/out
  Buffer: Pointer   // BYTE* out
): DWORD; stdcall;
  external 'TDH.dll' name 'TdhGetWppMessage';
result := DllCall("TDH\TdhGetWppMessage"
    , "Ptr", Handle   ; TDH_HANDLE
    , "Ptr", EventRecord   ; EVENT_RECORD*
    , "Ptr", BufferSize   ; DWORD* in/out
    , "Ptr", Buffer   ; BYTE* out
    , "UInt")   ; return: DWORD
●TdhGetWppMessage(Handle, EventRecord, BufferSize, Buffer) = DLL("TDH.dll", "dword TdhGetWppMessage(int, void*, void*, void*)")
# 呼び出し: TdhGetWppMessage(Handle, EventRecord, BufferSize, Buffer)
# Handle : TDH_HANDLE -> "int"
# EventRecord : EVENT_RECORD* -> "void*"
# BufferSize : DWORD* in/out -> "void*"
# Buffer : BYTE* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "tdh" fn TdhGetWppMessage(
    Handle: isize, // TDH_HANDLE
    EventRecord: [*c]EVENT_RECORD, // EVENT_RECORD*
    BufferSize: [*c]u32, // DWORD* in/out
    Buffer: [*c]u8 // BYTE* out
) callconv(std.os.windows.WINAPI) u32;
proc TdhGetWppMessage(
    Handle: int,  # TDH_HANDLE
    EventRecord: ptr EVENT_RECORD,  # EVENT_RECORD*
    BufferSize: ptr uint32,  # DWORD* in/out
    Buffer: ptr uint8  # BYTE* out
): uint32 {.importc: "TdhGetWppMessage", stdcall, dynlib: "TDH.dll".}
pragma(lib, "tdh");
extern(Windows)
uint TdhGetWppMessage(
    ptrdiff_t Handle,   // TDH_HANDLE
    EVENT_RECORD* EventRecord,   // EVENT_RECORD*
    uint* BufferSize,   // DWORD* in/out
    ubyte* Buffer   // BYTE* out
);
ccall((:TdhGetWppMessage, "TDH.dll"), stdcall, UInt32,
      (Int, Ptr{EVENT_RECORD}, Ptr{UInt32}, Ptr{UInt8}),
      Handle, EventRecord, BufferSize, Buffer)
# Handle : TDH_HANDLE -> Int
# EventRecord : EVENT_RECORD* -> Ptr{EVENT_RECORD}
# BufferSize : DWORD* in/out -> Ptr{UInt32}
# Buffer : BYTE* out -> Ptr{UInt8}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t TdhGetWppMessage(
    intptr_t Handle,
    void* EventRecord,
    uint32_t* BufferSize,
    uint8_t* Buffer);
]]
local tdh = ffi.load("tdh")
-- tdh.TdhGetWppMessage(Handle, EventRecord, BufferSize, Buffer)
-- Handle : TDH_HANDLE
-- EventRecord : EVENT_RECORD*
-- BufferSize : DWORD* in/out
-- Buffer : BYTE* out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('TDH.dll');
const TdhGetWppMessage = lib.func('__stdcall', 'TdhGetWppMessage', 'uint32_t', ['intptr_t', 'void *', 'uint32_t *', 'uint8_t *']);
// TdhGetWppMessage(Handle, EventRecord, BufferSize, Buffer)
// Handle : TDH_HANDLE -> 'intptr_t'
// EventRecord : EVENT_RECORD* -> 'void *'
// BufferSize : DWORD* in/out -> 'uint32_t *'
// Buffer : BYTE* out -> 'uint8_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("TDH.dll", {
  TdhGetWppMessage: { parameters: ["isize", "pointer", "pointer", "pointer"], result: "u32" },
});
// lib.symbols.TdhGetWppMessage(Handle, EventRecord, BufferSize, Buffer)
// Handle : TDH_HANDLE -> "isize"
// EventRecord : EVENT_RECORD* -> "pointer"
// BufferSize : DWORD* in/out -> "pointer"
// Buffer : BYTE* out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t TdhGetWppMessage(
    intptr_t Handle,
    void* EventRecord,
    uint32_t* BufferSize,
    uint8_t* Buffer);
C, "TDH.dll");
// $ffi->TdhGetWppMessage(Handle, EventRecord, BufferSize, Buffer);
// Handle : TDH_HANDLE
// EventRecord : EVENT_RECORD*
// BufferSize : DWORD* in/out
// Buffer : BYTE* out
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Tdh extends StdCallLibrary {
    Tdh INSTANCE = Native.load("tdh", Tdh.class);
    int TdhGetWppMessage(
        long Handle,   // TDH_HANDLE
        Pointer EventRecord,   // EVENT_RECORD*
        IntByReference BufferSize,   // DWORD* in/out
        byte[] Buffer   // BYTE* out
    );
}
@[Link("tdh")]
lib LibTDH
  fun TdhGetWppMessage = TdhGetWppMessage(
    Handle : LibC::SSizeT,   # TDH_HANDLE
    EventRecord : EVENT_RECORD*,   # EVENT_RECORD*
    BufferSize : UInt32*,   # DWORD* in/out
    Buffer : UInt8*   # BYTE* out
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef TdhGetWppMessageNative = Uint32 Function(IntPtr, Pointer<Void>, Pointer<Uint32>, Pointer<Uint8>);
typedef TdhGetWppMessageDart = int Function(int, Pointer<Void>, Pointer<Uint32>, Pointer<Uint8>);
final TdhGetWppMessage = DynamicLibrary.open('TDH.dll')
    .lookupFunction<TdhGetWppMessageNative, TdhGetWppMessageDart>('TdhGetWppMessage');
// Handle : TDH_HANDLE -> IntPtr
// EventRecord : EVENT_RECORD* -> Pointer<Void>
// BufferSize : DWORD* in/out -> Pointer<Uint32>
// Buffer : BYTE* out -> Pointer<Uint8>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function TdhGetWppMessage(
  Handle: NativeInt;   // TDH_HANDLE
  EventRecord: Pointer;   // EVENT_RECORD*
  BufferSize: Pointer;   // DWORD* in/out
  Buffer: Pointer   // BYTE* out
): DWORD; stdcall;
  external 'TDH.dll' name 'TdhGetWppMessage';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "TdhGetWppMessage"
  c_TdhGetWppMessage :: CIntPtr -> Ptr () -> Ptr Word32 -> Ptr Word8 -> IO Word32
-- Handle : TDH_HANDLE -> CIntPtr
-- EventRecord : EVENT_RECORD* -> Ptr ()
-- BufferSize : DWORD* in/out -> Ptr Word32
-- Buffer : BYTE* out -> Ptr Word8
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let tdhgetwppmessage =
  foreign "TdhGetWppMessage"
    (intptr_t @-> (ptr void) @-> (ptr uint32_t) @-> (ptr uint8_t) @-> returning uint32_t)
(* Handle : TDH_HANDLE -> intptr_t *)
(* EventRecord : EVENT_RECORD* -> (ptr void) *)
(* BufferSize : DWORD* in/out -> (ptr uint32_t) *)
(* Buffer : BYTE* out -> (ptr uint8_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library tdh (t "TDH.dll"))
(cffi:use-foreign-library tdh)

(cffi:defcfun ("TdhGetWppMessage" tdh-get-wpp-message :convention :stdcall) :uint32
  (handle :int64)   ; TDH_HANDLE
  (event-record :pointer)   ; EVENT_RECORD*
  (buffer-size :pointer)   ; DWORD* in/out
  (buffer :pointer))   ; BYTE* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $TdhGetWppMessage = Win32::API::More->new('TDH',
    'DWORD TdhGetWppMessage(LPARAM Handle, LPVOID EventRecord, LPVOID BufferSize, LPVOID Buffer)');
# my $ret = $TdhGetWppMessage->Call($Handle, $EventRecord, $BufferSize, $Buffer);
# Handle : TDH_HANDLE -> LPARAM
# EventRecord : EVENT_RECORD* -> LPVOID
# BufferSize : DWORD* in/out -> LPVOID
# Buffer : BYTE* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目
使用する型