ホーム › System.Diagnostics.Etw › EventWrite

EventWrite

関数

マニフェストベースのETWイベントを記録する。

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

シグネチャ

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

DWORD EventWrite(
    REGHANDLE RegHandle,
    const EVENT_DESCRIPTOR* EventDescriptor,
    DWORD UserDataCount,
    EVENT_DATA_DESCRIPTOR* UserData   // optional
);

パラメーター

名前	型	方向	説明
RegHandle	REGHANDLE	in	プロバイダーの登録ハンドル。このハンドルは EventRegister から取得します。生成されるイベントは、このハンドルに関連付けられた ProviderId を使用します。
EventDescriptor	EVENT_DESCRIPTOR*	in	ID、Version、Level、Keyword、Channel、Opcode、Task を含むイベント情報 (メタデータ) を保持する EVENT_DESCRIPTOR。重要 ProviderId、Level、Keyword は、イベントをフィルター処理するための主要な手段です。他の種類のフィルター処理も可能ですが、オーバーヘッドははるかに大きくなります。すべてのイベントに対して、常に 0 以外の Level と Keyword を割り当ててください。
UserDataCount	DWORD	in	UserData 内の EVENT_DATA_DESCRIPTOR 構造体の数。最大数は 128 です。
UserData	EVENT_DATA_DESCRIPTOR*	inoptional	イベントに含めるデータを記述する UserDataCount 個の EVENT_DATA_DESCRIPTOR 構造体の配列。UserDataCount が 0 の場合、UserData は NULL にできます。各 EVENT_DATA_DESCRIPTOR は、イベントに含める 1 つのメモリブロックを記述します。指定されたブロックは、パディングやアラインメントを行わずに順番に連結され、イベントの内容を構成します。マニフェストベースのデコードを使用する場合、イベントの内容は、マニフェスト内でイベントに関連付けられたテンプレートで指定されたレイアウトと一致する必要があります。

戻り値の型: DWORD

公式ドキュメント

現在のスレッドのアクティビティ ID を使用する ETW イベントを書き込みます。

戻り値

成功した場合は ERROR_SUCCESS を、失敗した場合はエラーコードを返します。返される可能性のあるエラーコードには、次のものがあります。

ERROR_INVALID_PARAMETER: 1 つ以上のパラメーターが無効です。
ERROR_INVALID_HANDLE: プロバイダーの登録ハンドルが無効です。
ERROR_ARITHMETIC_OVERFLOW: イベントサイズが、許可されている最大値 (64KB - ヘッダー) を超えています。
ERROR_MORE_DATA: セッションバッファーサイズがイベントに対して小さすぎます。
ERROR_NOT_ENOUGH_MEMORY: いっぱいになったバッファーをディスクにフラッシュしようとしているが、ディスク IO が十分な速さで行われていない場合に発生します。これは、ディスクが遅く、イベントトラフィックが多い場合に発生します。最終的に、空き (空の) バッファーがなくなり、イベントは破棄されます。
STATUS_LOG_FILE_FULL: リアルタイム再生ファイルがいっぱいです。リアルタイムコンシューマーが再生ファイルからイベントを消費するまで、イベントはセッションにログ記録されません。

エラーコードは、主にデバッグおよび診断のシナリオでの使用を目的としています。ほとんどの運用コードは、ETW イベントを書き込めなかった場合でも実行を継続し、イベントの報告を続けるべきです。そのため、リリースビルドでは通常、エラーコードを無視してかまいません。

解説(Remarks)

ほとんどのイベントプロバイダーは、EventWrite を直接呼び出すことはありません。代わりに、ほとんどのイベントプロバイダーは、EventRegister、EventWrite、EventUnregister の呼び出しをラップする ETW フレームワークを使用して実装されます。たとえば、イベントマニフェストを記述し、 Message Compiler を使用してイベントの C/C++ コードを生成することもできますし、マニフェストを不要にするために TraceLogging を使用することもできます。

EventWrite は、ProviderId (RegHandle から決定される)、Level、Keyword、その他のイベントの特性に基づいて、イベントを適切なトレースセッションにルーティングします。このイベントを記録しているトレースセッションが 1 つもない場合、この関数は何も行わず、ERROR_SUCCESS を返します。

どのトレースセッションでも記録されないイベントによるパフォーマンスへの影響を軽減するには、データを準備して EventWrite を呼び出す前に、 EventEnabled を呼び出して、イベントを記録しているトレースセッションがあるかどうかを判断できます。

EventWrite は、イベントのアクティビティ ID を現在のスレッドのアクティビティ ID に設定します。 EventWrite は、関連アクティビティ ID をイベントに含めません。別のアクティビティ ID を指定する場合、または関連アクティビティ ID を追加する場合は、 EventWriteTransfer を使用してください。

EventWrite は、Filter に 0、Flags に 0、ActivityId に NULL、RelatedActivityId に NULL を指定した EventWriteEx と同等です。

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

各言語での呼び出し定義

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

DWORD EventWrite(
    REGHANDLE RegHandle,
    const EVENT_DESCRIPTOR* EventDescriptor,
    DWORD UserDataCount,
    EVENT_DATA_DESCRIPTOR* UserData   // optional
);

[DllImport("ADVAPI32.dll", ExactSpelling = true)]
static extern uint EventWrite(
    long RegHandle,   // REGHANDLE
    IntPtr EventDescriptor,   // EVENT_DESCRIPTOR*
    uint UserDataCount,   // DWORD
    IntPtr UserData   // EVENT_DATA_DESCRIPTOR* optional
);

<DllImport("ADVAPI32.dll", ExactSpelling:=True)>
Public Shared Function EventWrite(
    RegHandle As Long,   ' REGHANDLE
    EventDescriptor As IntPtr,   ' EVENT_DESCRIPTOR*
    UserDataCount As UInteger,   ' DWORD
    UserData As IntPtr   ' EVENT_DATA_DESCRIPTOR* optional
) As UInteger
End Function

' RegHandle : REGHANDLE
' EventDescriptor : EVENT_DESCRIPTOR*
' UserDataCount : DWORD
' UserData : EVENT_DATA_DESCRIPTOR* optional
Declare PtrSafe Function EventWrite Lib "advapi32" ( _
    ByVal RegHandle As LongLong, _
    ByVal EventDescriptor As LongPtr, _
    ByVal UserDataCount As Long, _
    ByVal UserData As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

EventWrite = ctypes.windll.advapi32.EventWrite
EventWrite.restype = wintypes.DWORD
EventWrite.argtypes = [
    ctypes.c_longlong,  # RegHandle : REGHANDLE
    ctypes.c_void_p,  # EventDescriptor : EVENT_DESCRIPTOR*
    wintypes.DWORD,  # UserDataCount : DWORD
    ctypes.c_void_p,  # UserData : EVENT_DATA_DESCRIPTOR* optional
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ADVAPI32.dll')
EventWrite = Fiddle::Function.new(
  lib['EventWrite'],
  [
    Fiddle::TYPE_LONG_LONG,  # RegHandle : REGHANDLE
    Fiddle::TYPE_VOIDP,  # EventDescriptor : EVENT_DESCRIPTOR*
    -Fiddle::TYPE_INT,  # UserDataCount : DWORD
    Fiddle::TYPE_VOIDP,  # UserData : EVENT_DATA_DESCRIPTOR* optional
  ],
  -Fiddle::TYPE_INT)

#[link(name = "advapi32")]
extern "system" {
    fn EventWrite(
        RegHandle: i64,  // REGHANDLE
        EventDescriptor: *const EVENT_DESCRIPTOR,  // EVENT_DESCRIPTOR*
        UserDataCount: u32,  // DWORD
        UserData: *mut EVENT_DATA_DESCRIPTOR  // EVENT_DATA_DESCRIPTOR* optional
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("ADVAPI32.dll")]
public static extern uint EventWrite(long RegHandle, IntPtr EventDescriptor, uint UserDataCount, IntPtr UserData);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_EventWrite' -Namespace Win32 -PassThru
# $api::EventWrite(RegHandle, EventDescriptor, UserDataCount, UserData)

#uselib "ADVAPI32.dll"
#func global EventWrite "EventWrite" sptr, sptr, sptr, sptr
; EventWrite RegHandle, varptr(EventDescriptor), UserDataCount, varptr(UserData)   ; 戻り値は stat
; RegHandle : REGHANDLE -> "sptr"
; EventDescriptor : EVENT_DESCRIPTOR* -> "sptr"
; UserDataCount : DWORD -> "sptr"
; UserData : EVENT_DATA_DESCRIPTOR* optional -> "sptr"
; ※HSP3.7は int64 引数(64bit値渡し)に非対応です。
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "ADVAPI32.dll"
#cfunc global EventWrite "EventWrite" int64, var, int, var
; res = EventWrite(RegHandle, EventDescriptor, UserDataCount, UserData)
; RegHandle : REGHANDLE -> "int64"
; EventDescriptor : EVENT_DESCRIPTOR* -> "var"
; UserDataCount : DWORD -> "int"
; UserData : EVENT_DATA_DESCRIPTOR* optional -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
; ※int64 引数の DLL 値渡しは x64 ランタイム(hsp3_64)のみ対応(x86 は未対応)。#uselib "ADVAPI32.dll"
#cfunc global EventWrite "EventWrite" int64, sptr, int, sptr
; res = EventWrite(RegHandle, varptr(EventDescriptor), UserDataCount, varptr(UserData))
; RegHandle : REGHANDLE -> "int64"
; EventDescriptor : EVENT_DESCRIPTOR* -> "sptr"
; UserDataCount : DWORD -> "int"
; UserData : EVENT_DATA_DESCRIPTOR* optional -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; ※int64 引数の DLL 値渡しは x64 ランタイム(hsp3_64)のみ対応(x86 は未対応)。