ホーム › System.Diagnostics.Etw › ITraceEvent

ITraceEvent

COM

📘 Microsoft Learn (日本語) · English

IID8cc97f40-9028-4ff3-9b62-7d1f79ca7bcb継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

特定のイベントに関連するデータへのアクセスを提供します。

解説(Remarks)

このインターフェイスは、IA64 アーキテクチャの Windows 7 ではサポートされていません。

メソッド 12

vtbl = vtable インデックス(0始まり)。HSP等からCOMメソッドをインデックス指定で呼ぶ際に使用します。0〜2 は IUnknown。

vtbl 3 HRESULT Clone(ITraceEvent** NewEvent)

イベントの複製コピーを作成します。

NewEvent

ITraceEvent**

out

新しいイベント。

戻り値

型: HRESULT

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

vtbl 4 HRESULT GetUserContext(void** UserContext)

イベントが属するストリームに関連付けられたユーザーコンテキストを取得します。

UserContext

void**

out

ユーザーコンテキスト。これは ITraceRelogger::AddLogfileTraceStream の呼び出しで指定されたコンテキストです。

戻り値

型: HRESULT

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

vtbl 5 HRESULT GetEventRecord(EVENT_RECORD** EventRecord)

イベントを記述するイベントレコードを取得します。

EventRecord

EVENT_RECORD**

out

イベントレコード。

戻り値

型: HRESULT

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

解説(Remarks)

イベントレコードは、記録された時刻、長さ、イベントペイロードなど、イベントに関連付けられたメタデータを記述します。

vtbl 6 HRESULT SetPayload(BYTE* Payload, DWORD PayloadSize)

イベントのペイロードを設定します。

Payload	BYTE*	in	イベントペイロードデータ。
PayloadSize	DWORD	in	ペイロードデータのサイズ(バイト単位)。

戻り値

型: HRESULT

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

解説(Remarks)

ペイロードには、開発者が定義したデータのみが含まれます。

vtbl 7 HRESULT SetEventDescriptor(EVENT_DESCRIPTOR* EventDescriptor)

イベントのイベント記述子を設定します。

EventDescriptor

EVENT_DESCRIPTOR*

イベント記述子データ。

戻り値

型: HRESULT

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

vtbl 8 HRESULT SetProcessId(DWORD ProcessId)

イベントを特定のプロセスに割り当てます。

ProcessId

DWORD

このイベントを所有するプロセスの識別子。

戻り値

型: HRESULT

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

vtbl 9 HRESULT SetProcessorIndex(DWORD ProcessorIndex)

現在のスレッドにプロセッサーインデックスを設定します。

ProcessorIndex

DWORD

プロセッサーインデックス。

戻り値

型: HRESULT

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

vtbl 10 HRESULT SetThreadId(DWORD ThreadId)

イベントを生成するスレッドの識別子を設定します。

ThreadId

DWORD

イベントを生成するスレッドの識別子。

戻り値

型: HRESULT

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

vtbl 11 HRESULT SetThreadTimes(DWORD KernelTime, DWORD UserTime)

現在のスレッドにスレッド時刻を設定します。

KernelTime	DWORD	in	イベントに設定するカーネルモードでの実行時間を指定する。
UserTime	DWORD	in	イベントに設定するユーザーモードでの実行時間を指定する。

戻り値

型: HRESULT

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

vtbl 12 HRESULT SetActivityId(GUID* ActivityId)

現在のスレッドにアクティビティ ID を設定します。

ActivityId

GUID*

アクティビティ ID。

戻り値

型: HRESULT

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

vtbl 13 HRESULT SetTimeStamp(LONGLONG* TimeStamp)

イベントが発生した時刻を設定します。

TimeStamp

LONGLONG*

イベントが発生した時刻(システム時刻)。

戻り値

型: HRESULT

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

vtbl 14 HRESULT SetProviderId(GUID* ProviderId)

イベントをトレースしたプロバイダーの GUID を設定します。

ProviderId

GUID*

プロバイダーの一意の識別子。

戻り値

型: HRESULT

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

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

HSP用 COM定義

#usecom / #comfunc によるHSPのCOM呼び出し定義。数字は vtbl インデックス(0始まり)。クラスIDが無い場合 #usecom の末尾は "{}"、ある場合は "{CLSID}"。

出力引数:

#define global IID_ITraceEvent "{8CC97F40-9028-4FF3-9B62-7D1F79CA7BCB}"
#usecom global ITraceEvent IID_ITraceEvent "{}"
#comfunc global ITraceEvent_Clone               3 sptr
#comfunc global ITraceEvent_GetUserContext      4 sptr
#comfunc global ITraceEvent_GetEventRecord      5 var
#comfunc global ITraceEvent_SetPayload          6 var,int
#comfunc global ITraceEvent_SetEventDescriptor  7 var
#comfunc global ITraceEvent_SetProcessId        8 int
#comfunc global ITraceEvent_SetProcessorIndex   9 int
#comfunc global ITraceEvent_SetThreadId         10 int
#comfunc global ITraceEvent_SetThreadTimes      11 int,int
#comfunc global ITraceEvent_SetActivityId       12 var
#comfunc global ITraceEvent_SetTimeStamp        13 var
#comfunc global ITraceEvent_SetProviderId       14 var
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。#define global IID_ITraceEvent "{8CC97F40-9028-4FF3-9B62-7D1F79CA7BCB}"
#usecom global ITraceEvent IID_ITraceEvent "{}"
#comfunc global ITraceEvent_Clone               3 sptr
#comfunc global ITraceEvent_GetUserContext      4 sptr
#comfunc global ITraceEvent_GetEventRecord      5 sptr
#comfunc global ITraceEvent_SetPayload          6 sptr,int
#comfunc global ITraceEvent_SetEventDescriptor  7 sptr
#comfunc global ITraceEvent_SetProcessId        8 int
#comfunc global ITraceEvent_SetProcessorIndex   9 int
#comfunc global ITraceEvent_SetThreadId         10 int
#comfunc global ITraceEvent_SetThreadTimes      11 int,int
#comfunc global ITraceEvent_SetActivityId       12 sptr
#comfunc global ITraceEvent_SetTimeStamp        13 sptr
#comfunc global ITraceEvent_SetProviderId       14 sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。