ホーム › System.Diagnostics.Etw › TdhGetEventMapInformation

TdhGetEventMapInformation

関数

イベントのマップ情報(列挙やビットマップ)を取得する。

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

シグネチャ

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

DWORD TdhGetEventMapInformation(
    EVENT_RECORD* pEvent,
    LPWSTR pMapName,
    EVENT_MAP_INFO* pBuffer,   // optional
    DWORD* pBufferSize
);

パラメーター

名前	型	方向	説明
pEvent	EVENT_RECORD*	in	EventRecordCallback コールバックに渡されるイベントレコードです。詳細については、EVENT_RECORD 構造体を参照してください。
pMapName	LPWSTR	in	マップ属性値の名前を含む、null 終端の Unicode 文字列です。この名前は、EVENT_PROPERTY_INFO 構造体の MapNameOffset メンバーに由来します。
pBuffer	EVENT_MAP_INFO*	outoptional	イベントマップを受け取るためのユーザー割り当てバッファーです。マップは、値マップ、ビットマップ、またはパターンマップのいずれかになります。詳細については、EVENT_MAP_INFO 構造体を参照してください。
pBufferSize	DWORD*	inout	pBuffer バッファーのサイズ (バイト単位) です。関数が成功した場合、このパラメーターには使用されたバッファーのサイズが格納されます。バッファーが小さすぎる場合、関数は ERROR_INSUFFICIENT_BUFFER を返し、このパラメーターに必要なバッファーサイズを設定します。入力時にバッファーサイズが 0 の場合、バッファーにはデータが返されず、このパラメーターに必要なバッファーサイズが格納されます。

戻り値の型: DWORD

公式ドキュメント

イベントに含まれるイベントマップに関する情報を取得します。

戻り値

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

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

解説(Remarks)

この関数を使用して、WPP イベントのイベントマップ情報を取得することはできません。

マニフェストで定義されたマップの場合、文字列の末尾にスペースが含まれます。たとえば、マニフェストで値が "Monday" にマップされている場合、文字列は "Monday " として返されます。

例

この関数の呼び出し方法を示す例については、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 TdhGetEventMapInformation(
    EVENT_RECORD* pEvent,
    LPWSTR pMapName,
    EVENT_MAP_INFO* pBuffer,   // optional
    DWORD* pBufferSize
);

[DllImport("TDH.dll", ExactSpelling = true)]
static extern uint TdhGetEventMapInformation(
    IntPtr pEvent,   // EVENT_RECORD*
    [MarshalAs(UnmanagedType.LPWStr)] string pMapName,   // LPWSTR
    IntPtr pBuffer,   // EVENT_MAP_INFO* optional, out
    ref uint pBufferSize   // DWORD* in/out
);

<DllImport("TDH.dll", ExactSpelling:=True)>
Public Shared Function TdhGetEventMapInformation(
    pEvent As IntPtr,   ' EVENT_RECORD*
    <MarshalAs(UnmanagedType.LPWStr)> pMapName As String,   ' LPWSTR
    pBuffer As IntPtr,   ' EVENT_MAP_INFO* optional, out
    ByRef pBufferSize As UInteger   ' DWORD* in/out
) As UInteger
End Function

' pEvent : EVENT_RECORD*
' pMapName : LPWSTR
' pBuffer : EVENT_MAP_INFO* optional, out
' pBufferSize : DWORD* in/out
Declare PtrSafe Function TdhGetEventMapInformation Lib "tdh" ( _
    ByVal pEvent As LongPtr, _
    ByVal pMapName As LongPtr, _
    ByVal pBuffer As LongPtr, _
    ByRef pBufferSize As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

TdhGetEventMapInformation = ctypes.windll.tdh.TdhGetEventMapInformation
TdhGetEventMapInformation.restype = wintypes.DWORD
TdhGetEventMapInformation.argtypes = [
    ctypes.c_void_p,  # pEvent : EVENT_RECORD*
    wintypes.LPCWSTR,  # pMapName : LPWSTR
    ctypes.c_void_p,  # pBuffer : EVENT_MAP_INFO* optional, out
    ctypes.POINTER(wintypes.DWORD),  # pBufferSize : DWORD* in/out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('TDH.dll')
TdhGetEventMapInformation = Fiddle::Function.new(
  lib['TdhGetEventMapInformation'],
  [
    Fiddle::TYPE_VOIDP,  # pEvent : EVENT_RECORD*
    Fiddle::TYPE_VOIDP,  # pMapName : LPWSTR
    Fiddle::TYPE_VOIDP,  # pBuffer : EVENT_MAP_INFO* optional, out
    Fiddle::TYPE_VOIDP,  # pBufferSize : DWORD* in/out
  ],
  -Fiddle::TYPE_INT)

#[link(name = "tdh")]
extern "system" {
    fn TdhGetEventMapInformation(
        pEvent: *mut EVENT_RECORD,  // EVENT_RECORD*
        pMapName: *mut u16,  // LPWSTR
        pBuffer: *mut EVENT_MAP_INFO,  // EVENT_MAP_INFO* optional, out
        pBufferSize: *mut u32  // DWORD* in/out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("TDH.dll")]
public static extern uint TdhGetEventMapInformation(IntPtr pEvent, [MarshalAs(UnmanagedType.LPWStr)] string pMapName, IntPtr pBuffer, ref uint pBufferSize);
"@
$api = Add-Type -MemberDefinition $sig -Name 'TDH_TdhGetEventMapInformation' -Namespace Win32 -PassThru
# $api::TdhGetEventMapInformation(pEvent, pMapName, pBuffer, pBufferSize)

#uselib "TDH.dll"
#func global TdhGetEventMapInformation "TdhGetEventMapInformation" sptr, sptr, sptr, sptr
; TdhGetEventMapInformation varptr(pEvent), pMapName, varptr(pBuffer), varptr(pBufferSize)   ; 戻り値は stat
; pEvent : EVENT_RECORD* -> "sptr"
; pMapName : LPWSTR -> "sptr"
; pBuffer : EVENT_MAP_INFO* optional, out -> "sptr"
; pBufferSize : DWORD* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "TDH.dll"
#cfunc global TdhGetEventMapInformation "TdhGetEventMapInformation" var, wstr, var, var
; res = TdhGetEventMapInformation(pEvent, pMapName, pBuffer, pBufferSize)
; pEvent : EVENT_RECORD* -> "var"
; pMapName : LPWSTR -> "wstr"
; pBuffer : EVENT_MAP_INFO* optional, out -> "var"
; pBufferSize : DWORD* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "TDH.dll"
#cfunc global TdhGetEventMapInformation "TdhGetEventMapInformation" sptr, wstr, sptr, sptr
; res = TdhGetEventMapInformation(varptr(pEvent), pMapName, varptr(pBuffer), varptr(pBufferSize))
; pEvent : EVENT_RECORD* -> "sptr"
; pMapName : LPWSTR -> "wstr"
; pBuffer : EVENT_MAP_INFO* optional, out -> "sptr"
; pBufferSize : DWORD* in/out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。