ホーム › System.Diagnostics.Etw › TraceEventInstance

TraceEventInstance

関数

親子関係を持つイベントインスタンスをトレースに記録する。

DLLADVAPI32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

DWORD TraceEventInstance(
    ULONGLONG TraceHandle,
    EVENT_INSTANCE_HEADER* EventTrace,
    EVENT_INSTANCE_INFO* InstInfo,
    EVENT_INSTANCE_INFO* ParentInstInfo   // optional
);

パラメーター

名前	型	方向	説明
TraceHandle	ULONGLONG	in	イベントインスタンスを記録するイベントトレースセッションへのハンドルです。プロバイダーは、ControlCallback の実装内で GetTraceLoggerHandle 関数を呼び出すことでこのハンドルを取得します。
EventTrace	EVENT_INSTANCE_HEADER*	in	EVENT_INSTANCE_HEADER 構造体へのポインターです。イベント固有のデータを構造体に付加することもできます。ログに記録できるイベントの最大サイズは 64K です。EVENT_INSTANCE_HEADER 構造体の次のメンバーには値を指定する必要があります。 Size Flags RegHandle プロバイダーが提供する情報の複雑さに応じて、次のメンバーにも値を指定することを検討してください。 Class.Type Class.Level 関連するイベント間の階層関係をトレースするには、ParentRegHandle メンバーも設定します。
InstInfo	EVENT_INSTANCE_INFO*	in	EVENT_INSTANCE_INFO 構造体へのポインターです。この構造体には、このイベントトレースクラスの登録ハンドルとインスタンス識別子が含まれます。構造体を初期化するには CreateTraceInstanceId 関数を使用します。
ParentInstInfo	EVENT_INSTANCE_INFO*	inoptional	EVENT_INSTANCE_INFO 構造体へのポインターです。この構造体には、親イベントトレースクラスの登録ハンドルとそのインスタンス識別子が含まれます。構造体を初期化するには CreateTraceInstanceId 関数を使用します。階層関係をトレースしない場合は NULL を設定します。

戻り値の型: DWORD

公式ドキュメント

RegisterTraceGuids ベース(「クラシック」)のイベントプロバイダーは、

戻り値

関数が成功した場合、戻り値は ERROR_SUCCESS です。

関数が失敗した場合、戻り値はシステムエラーコードのいずれかになります。以下は一般的なエラーとその原因です。

ERROR_INVALID_FLAGS

EVENT_INSTANCE_HEADER の Flags メンバーに WNODE_FLAG_TRACED_GUID が含まれていません。
ERROR_OUTOFMEMORY

関数呼び出しを完了するのに十分なメモリがありませんでした。このエラーコードの原因については、後述の「解説」セクションで説明します。
ERROR_INVALID_PARAMETER

次のいずれかが該当します。
- EventTrace が NULL です。
- pInstInfo が NULL です。
- pInstInfo のメンバーが NULL です。
- TraceHandle が NULL です。
- EVENT_INSTANCE_HEADER の Size メンバーが正しくありません。
ERROR_INVALID_HANDLE

TraceHandle が無効であるか、NT Kernel Logger セッションのハンドルを指定しています。
ERROR_NOT_ENOUGH_MEMORY

書き込み可能な空きバッファーがセッションに残っていませんでした。これは、ディスクサブシステムが過負荷であるか、バッファー数が少なすぎるために、イベントレートが高いときに発生することがあります。TraceEvent は、より多くのバッファーが利用可能になるまでブロックするのではなく、イベントを破棄します。

Windows 2000 および Windows XP: サポートされていません。
ERROR_OUTOFMEMORY

バッファープールが最大サイズに達していないにもかかわらず、追加のバッファーを割り当てるのに十分な利用可能なメモリがなく、イベントを受け取れるバッファーもないため、イベントが破棄されます。
ERROR_MORE_DATA

単一のイベントのデータが複数のバッファーにまたがることはできません。トレースイベントは、イベントトレースセッションのバッファーのサイズから EVENT_INSTANCE_HEADER 構造体のサイズを引いたサイズに制限されます。

解説(Remarks)

MOF ベースの ETW プロバイダーがこの関数を呼び出します。

メモ

ほとんどの開発者はこの関数を呼び出しません。この API は MOF ベースの ETW をサポートしていますが、MOF ベースの ETW は非推奨であり、マニフェストベースの ETW の使用が推奨されます。さらに、ほとんどの MOF ベースのプロバイダーは、ETW API を直接呼び出すのではなく、MC.exe によって生成されたラッパー関数を使用します。

プロバイダーがこの関数を呼び出す前に、プロバイダーは次の処理を行う必要があります。

自身とイベントトレースクラスを登録するために、RegisterTraceGuids 関数を呼び出す必要があります。
登録済みのイベントトレースクラスのインスタンス識別子を作成するために、CreateTraceInstanceId 関数を呼び出す必要があります。
有効化されている必要があります。コントローラーは EnableTrace 関数を呼び出してプロバイダーを有効化します。

イベントは、ログファイルに書き込まれるか、リアルタイムでイベントトレースコンシューマーに送信されるか、またはその両方が行われます。イベントの送信先は、StartTrace に渡される EVENT_TRACE_PROPERTIES 構造体の LogFileMode メンバーによって定義されます。

トレースイベントは、発生した順序で書き込まれます。

関連性のないイベントをトレースするには、TraceEvent 関数を使用します。

Windows XP: 正しく動作しません。

例

CreateTraceInstanceId と TraceEventInstance を使用して関連するイベントのセットを生成する例については、Tracing Event Instances を参照してください。

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

各言語での呼び出し定義

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

DWORD TraceEventInstance(
    ULONGLONG TraceHandle,
    EVENT_INSTANCE_HEADER* EventTrace,
    EVENT_INSTANCE_INFO* InstInfo,
    EVENT_INSTANCE_INFO* ParentInstInfo   // optional
);

[DllImport("ADVAPI32.dll", ExactSpelling = true)]
static extern uint TraceEventInstance(
    ulong TraceHandle,   // ULONGLONG
    IntPtr EventTrace,   // EVENT_INSTANCE_HEADER*
    IntPtr InstInfo,   // EVENT_INSTANCE_INFO*
    IntPtr ParentInstInfo   // EVENT_INSTANCE_INFO* optional
);

<DllImport("ADVAPI32.dll", ExactSpelling:=True)>
Public Shared Function TraceEventInstance(
    TraceHandle As ULong,   ' ULONGLONG
    EventTrace As IntPtr,   ' EVENT_INSTANCE_HEADER*
    InstInfo As IntPtr,   ' EVENT_INSTANCE_INFO*
    ParentInstInfo As IntPtr   ' EVENT_INSTANCE_INFO* optional
) As UInteger
End Function

' TraceHandle : ULONGLONG
' EventTrace : EVENT_INSTANCE_HEADER*
' InstInfo : EVENT_INSTANCE_INFO*
' ParentInstInfo : EVENT_INSTANCE_INFO* optional
Declare PtrSafe Function TraceEventInstance Lib "advapi32" ( _
    ByVal TraceHandle As LongLong, _
    ByVal EventTrace As LongPtr, _
    ByVal InstInfo As LongPtr, _
    ByVal ParentInstInfo As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

TraceEventInstance = ctypes.windll.advapi32.TraceEventInstance
TraceEventInstance.restype = wintypes.DWORD
TraceEventInstance.argtypes = [
    ctypes.c_ulonglong,  # TraceHandle : ULONGLONG
    ctypes.c_void_p,  # EventTrace : EVENT_INSTANCE_HEADER*
    ctypes.c_void_p,  # InstInfo : EVENT_INSTANCE_INFO*
    ctypes.c_void_p,  # ParentInstInfo : EVENT_INSTANCE_INFO* optional
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ADVAPI32.dll')
TraceEventInstance = Fiddle::Function.new(
  lib['TraceEventInstance'],
  [
    -Fiddle::TYPE_LONG_LONG,  # TraceHandle : ULONGLONG
    Fiddle::TYPE_VOIDP,  # EventTrace : EVENT_INSTANCE_HEADER*
    Fiddle::TYPE_VOIDP,  # InstInfo : EVENT_INSTANCE_INFO*
    Fiddle::TYPE_VOIDP,  # ParentInstInfo : EVENT_INSTANCE_INFO* optional
  ],
  -Fiddle::TYPE_INT)

#[link(name = "advapi32")]
extern "system" {
    fn TraceEventInstance(
        TraceHandle: u64,  // ULONGLONG
        EventTrace: *mut EVENT_INSTANCE_HEADER,  // EVENT_INSTANCE_HEADER*
        InstInfo: *mut EVENT_INSTANCE_INFO,  // EVENT_INSTANCE_INFO*
        ParentInstInfo: *mut EVENT_INSTANCE_INFO  // EVENT_INSTANCE_INFO* optional
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("ADVAPI32.dll")]
public static extern uint TraceEventInstance(ulong TraceHandle, IntPtr EventTrace, IntPtr InstInfo, IntPtr ParentInstInfo);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_TraceEventInstance' -Namespace Win32 -PassThru
# $api::TraceEventInstance(TraceHandle, EventTrace, InstInfo, ParentInstInfo)

#uselib "ADVAPI32.dll"
#func global TraceEventInstance "TraceEventInstance" sptr, sptr, sptr, sptr
; TraceEventInstance TraceHandle, varptr(EventTrace), varptr(InstInfo), varptr(ParentInstInfo)   ; 戻り値は stat
; TraceHandle : ULONGLONG -> "sptr"
; EventTrace : EVENT_INSTANCE_HEADER* -> "sptr"
; InstInfo : EVENT_INSTANCE_INFO* -> "sptr"
; ParentInstInfo : EVENT_INSTANCE_INFO* optional -> "sptr"
; ※HSP3.7は int64 引数(64bit値渡し)に非対応です。
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "ADVAPI32.dll"
#cfunc global TraceEventInstance "TraceEventInstance" int64, var, var, var
; res = TraceEventInstance(TraceHandle, EventTrace, InstInfo, ParentInstInfo)
; TraceHandle : ULONGLONG -> "int64"
; EventTrace : EVENT_INSTANCE_HEADER* -> "var"
; InstInfo : EVENT_INSTANCE_INFO* -> "var"
; ParentInstInfo : EVENT_INSTANCE_INFO* optional -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
; ※int64 引数の DLL 値渡しは x64 ランタイム(hsp3_64)のみ対応(x86 は未対応)。#uselib "ADVAPI32.dll"
#cfunc global TraceEventInstance "TraceEventInstance" int64, sptr, sptr, sptr
; res = TraceEventInstance(TraceHandle, varptr(EventTrace), varptr(InstInfo), varptr(ParentInstInfo))
; TraceHandle : ULONGLONG -> "int64"
; EventTrace : EVENT_INSTANCE_HEADER* -> "sptr"
; InstInfo : EVENT_INSTANCE_INFO* -> "sptr"
; ParentInstInfo : EVENT_INSTANCE_INFO* optional -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; ※int64 引数の DLL 値渡しは x64 ランタイム(hsp3_64)のみ対応(x86 は未対応)。