ホーム › System.Diagnostics.Etw › EventWriteTransfer

EventWriteTransfer

関数

アクティビティIDを指定してETWイベントを記録する。

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

シグネチャ

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

DWORD EventWriteTransfer(
    REGHANDLE RegHandle,
    const EVENT_DESCRIPTOR* EventDescriptor,
    const GUID* ActivityId,   // optional
    const GUID* RelatedActivityId,   // optional
    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 を割り当ててください。
ActivityId	GUID*	inoptional	このイベントの 128 ビットのアクティビティ ID への省略可能なポインター。これが非 NULL の場合、EventWriteTransfer は指定された値をイベントのアクティビティ ID として使用します。 NULL の場合、EventWriteTransfer は現在のスレッドのアクティビティ ID を使用します。トレース処理ツールは、イベントのアクティビティ ID を使用してイベントをアクティビティと呼ばれるグループに編成できます。アクティビティ ID の詳細については、 EventActivityIdControl を参照してください。
RelatedActivityId	GUID*	inoptional	このイベントのアクティビティの親となる 128 ビットのアクティビティ ID への省略可能なポインター。これが非 NULL の場合、EventWriteTransfer は指定された値をイベントの関連アクティビティ ID として使用します。 NULL の場合、イベントには関連アクティビティ ID が設定されません。関連アクティビティ ID は通常、アクティビティの START イベント (アクティビティの最初のイベント。Opcode = START でログに記録されます) に設定されます。トレース処理ツールは、イベントの関連アクティビティ ID を使用してアクティビティ間の関係を判断できます。たとえば、関連アクティビティが、新しく開始されたアクティビティの親であるといった関係です。関連アクティビティ ID の詳細については、 EventActivityIdControl を参照してください。
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 と省略可能な関連アクティビティ 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)

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

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

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

EventWriteTransfer は、Filter に 0、Flags に 0 を指定した 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 EventWriteTransfer(
    REGHANDLE RegHandle,
    const EVENT_DESCRIPTOR* EventDescriptor,
    const GUID* ActivityId,   // optional
    const GUID* RelatedActivityId,   // optional
    DWORD UserDataCount,
    EVENT_DATA_DESCRIPTOR* UserData   // optional
);

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

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

' RegHandle : REGHANDLE
' EventDescriptor : EVENT_DESCRIPTOR*
' ActivityId : GUID* optional
' RelatedActivityId : GUID* optional
' UserDataCount : DWORD
' UserData : EVENT_DATA_DESCRIPTOR* optional
Declare PtrSafe Function EventWriteTransfer Lib "advapi32" ( _
    ByVal RegHandle As LongLong, _
    ByVal EventDescriptor As LongPtr, _
    ByVal ActivityId As LongPtr, _
    ByVal RelatedActivityId 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

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

require 'fiddle'
require 'fiddle/import'

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

#[link(name = "advapi32")]
extern "system" {
    fn EventWriteTransfer(
        RegHandle: i64,  // REGHANDLE
        EventDescriptor: *const EVENT_DESCRIPTOR,  // EVENT_DESCRIPTOR*
        ActivityId: *const GUID,  // GUID* optional
        RelatedActivityId: *const GUID,  // GUID* optional
        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 EventWriteTransfer(long RegHandle, IntPtr EventDescriptor, IntPtr ActivityId, IntPtr RelatedActivityId, uint UserDataCount, IntPtr UserData);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_EventWriteTransfer' -Namespace Win32 -PassThru
# $api::EventWriteTransfer(RegHandle, EventDescriptor, ActivityId, RelatedActivityId, UserDataCount, UserData)

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

出力引数:

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