Win32 API 日本語リファレンス
ホームSystem.Diagnostics.Etw › TraceMessageVa

TraceMessageVa

関数
可変引数リストを用いてWPPトレースメッセージを送信する。
DLLADVAPI32.dll呼出規約winapi対応OSWindows XP 以降

シグネチャ

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

WIN32_ERROR TraceMessageVa(
    ULONGLONG LoggerHandle,
    TRACE_MESSAGE_FLAGS MessageFlags,
    const GUID* MessageGuid,
    WORD MessageNumber,
    CHAR* MessageArgList
);

パラメーター

名前方向説明
LoggerHandleULONGLONGinイベントを記録するイベント トレース セッションへのハンドル。プロバイダーは、 ControlCallback の実装内で GetTraceLoggerHandle 関数を呼び出すことで このハンドルを取得します。
MessageFlagsTRACE_MESSAGE_FLAGSin

イベントのプロバイダー固有データ セクションの先頭に追加情報を付加します。 イベントのプロバイダー固有データ セクションには、設定されたフラグに対応する データのみが含まれます。可変長の引数データ リストはこの情報の後に続きます。 このパラメーターには、次の値のうち 1 つ以上を指定できます。

  • TRACE_MESSAGE_GUID: イベント トレース クラス GUID をメッセージに含めます。 MessageGuid パラメーターにイベント トレース クラス GUID を指定します。

  • TRACE_MESSAGE_SEQUENCE: シーケンス番号をメッセージに含めます。 シーケンス番号は 1 から始まります。このフラグを使用するには、コントローラーが セッション作成時に EVENT_TRACE_USE_GLOBAL_SEQUENCE または EVENT_TRACE_USE_LOCAL_SEQUENCE のログ ファイル モードを設定している必要があります。

  • TRACE_MESSAGE_SYSTEMINFO: スレッド識別子とプロセス識別子をメッセージに含めます。

  • TRACE_MESSAGE_TIMESTAMP: タイム スタンプをメッセージに含めます。

情報はイベント データに次の順序で含まれます。

  • シーケンス番号
  • イベント トレース クラス GUID
  • タイム スタンプ
  • スレッド識別子
  • プロセス識別子
MessageGuidGUID*inイベント トレース メッセージを識別するクラス GUID。
MessageNumberWORDinメッセージの各発生を一意に識別する番号。このパラメーターに指定する値は 呼び出し側が定義する必要があり、アプリケーションにとって意味のある値であるべきです。
MessageArgListCHAR*in

メッセージに追加される可変長引数のリスト。リストは次のように引数のペアで 構成する必要があります。

  • PVOID: 引数データへのポインター。
  • size_t: 引数データのサイズ (バイト単位)。

NULL へのポインターとゼロから成る引数ペアでリストを終端します。

呼び出し側は、引数のサイズの合計 + 72 がイベント トレース セッションの バッファーのサイズを超えないことを保証する必要があります。

戻り値の型: WIN32_ERROR

公式ドキュメント

RegisterTraceGuids ベースの ("クラシック") イベント プロバイダーは TraceMessageVa を使用します

戻り値

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

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

解説(Remarks)

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

メモ

ほとんどの開発者はこの関数を直接呼び出すことはありません。WPP プロバイダーは、 ETW API を呼び出す代わりに、tracewpp.exe によって生成されるラッパー関数を使用します。

ラッパー関数からメッセージ トレース機能にアクセスする必要がない場合は、 この関数の TraceMessage バージョンを 呼び出すことができます。

MessageFlags パラメーターに TRACE_MESSAGE_GUID フラグが含まれていない場合、 コンシューマーはイベントを受信して処理するために EventCallback コールバックを使用する必要があります。 TRACE_MESSAGE_GUID フラグを指定しない場合、EVENT_TRACE 構造体の Header.Guid メンバーにイベント トレース クラス GUID が含まれないため、 コンシューマーは EventClassCallback を 使用できません。

MessageFlags フラグに対応する EVENT_TRACE および EVENT_TRACE_HEADER 構造体のメンバーは、 対応するフラグが指定された場合にのみ設定される点に注意してください。たとえば、 EVENT_TRACE_HEADERThreadId および ProcessId メンバーは、 TRACE_MESSAGE_SYSTEMINFO フラグを指定した場合にのみ設定されます。

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

各言語での呼び出し定義

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

WIN32_ERROR TraceMessageVa(
    ULONGLONG LoggerHandle,
    TRACE_MESSAGE_FLAGS MessageFlags,
    const GUID* MessageGuid,
    WORD MessageNumber,
    CHAR* MessageArgList
);
[DllImport("ADVAPI32.dll", ExactSpelling = true)]
static extern uint TraceMessageVa(
    ulong LoggerHandle,   // ULONGLONG
    uint MessageFlags,   // TRACE_MESSAGE_FLAGS
    ref Guid MessageGuid,   // GUID*
    ushort MessageNumber,   // WORD
    IntPtr MessageArgList   // CHAR*
);
<DllImport("ADVAPI32.dll", ExactSpelling:=True)>
Public Shared Function TraceMessageVa(
    LoggerHandle As ULong,   ' ULONGLONG
    MessageFlags As UInteger,   ' TRACE_MESSAGE_FLAGS
    ByRef MessageGuid As Guid,   ' GUID*
    MessageNumber As UShort,   ' WORD
    MessageArgList As IntPtr   ' CHAR*
) As UInteger
End Function
' LoggerHandle : ULONGLONG
' MessageFlags : TRACE_MESSAGE_FLAGS
' MessageGuid : GUID*
' MessageNumber : WORD
' MessageArgList : CHAR*
Declare PtrSafe Function TraceMessageVa Lib "advapi32" ( _
    ByVal LoggerHandle As LongLong, _
    ByVal MessageFlags As Long, _
    ByVal MessageGuid As LongPtr, _
    ByVal MessageNumber As Integer, _
    ByVal MessageArgList As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

TraceMessageVa = ctypes.windll.advapi32.TraceMessageVa
TraceMessageVa.restype = wintypes.DWORD
TraceMessageVa.argtypes = [
    ctypes.c_ulonglong,  # LoggerHandle : ULONGLONG
    wintypes.DWORD,  # MessageFlags : TRACE_MESSAGE_FLAGS
    ctypes.c_void_p,  # MessageGuid : GUID*
    ctypes.c_ushort,  # MessageNumber : WORD
    ctypes.POINTER(ctypes.c_byte),  # MessageArgList : CHAR*
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ADVAPI32.dll')
TraceMessageVa = Fiddle::Function.new(
  lib['TraceMessageVa'],
  [
    -Fiddle::TYPE_LONG_LONG,  # LoggerHandle : ULONGLONG
    -Fiddle::TYPE_INT,  # MessageFlags : TRACE_MESSAGE_FLAGS
    Fiddle::TYPE_VOIDP,  # MessageGuid : GUID*
    -Fiddle::TYPE_SHORT,  # MessageNumber : WORD
    Fiddle::TYPE_VOIDP,  # MessageArgList : CHAR*
  ],
  -Fiddle::TYPE_INT)
#[link(name = "advapi32")]
extern "system" {
    fn TraceMessageVa(
        LoggerHandle: u64,  // ULONGLONG
        MessageFlags: u32,  // TRACE_MESSAGE_FLAGS
        MessageGuid: *const GUID,  // GUID*
        MessageNumber: u16,  // WORD
        MessageArgList: *mut i8  // CHAR*
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("ADVAPI32.dll")]
public static extern uint TraceMessageVa(ulong LoggerHandle, uint MessageFlags, ref Guid MessageGuid, ushort MessageNumber, IntPtr MessageArgList);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_TraceMessageVa' -Namespace Win32 -PassThru
# $api::TraceMessageVa(LoggerHandle, MessageFlags, MessageGuid, MessageNumber, MessageArgList)
#uselib "ADVAPI32.dll"
#func global TraceMessageVa "TraceMessageVa" sptr, sptr, sptr, sptr, sptr
; TraceMessageVa LoggerHandle, MessageFlags, varptr(MessageGuid), MessageNumber, varptr(MessageArgList)   ; 戻り値は stat
; LoggerHandle : ULONGLONG -> "sptr"
; MessageFlags : TRACE_MESSAGE_FLAGS -> "sptr"
; MessageGuid : GUID* -> "sptr"
; MessageNumber : WORD -> "sptr"
; MessageArgList : CHAR* -> "sptr"
; ※HSP3.7は int64 引数(64bit値渡し)に非対応です。
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "ADVAPI32.dll"
#cfunc global TraceMessageVa "TraceMessageVa" int64, int, var, int, var
; res = TraceMessageVa(LoggerHandle, MessageFlags, MessageGuid, MessageNumber, MessageArgList)
; LoggerHandle : ULONGLONG -> "int64"
; MessageFlags : TRACE_MESSAGE_FLAGS -> "int"
; MessageGuid : GUID* -> "var"
; MessageNumber : WORD -> "int"
; MessageArgList : CHAR* -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
; ※int64 引数の DLL 値渡しは x64 ランタイム(hsp3_64)のみ対応(x86 は未対応)。
出力引数:
; WIN32_ERROR TraceMessageVa(ULONGLONG LoggerHandle, TRACE_MESSAGE_FLAGS MessageFlags, GUID* MessageGuid, WORD MessageNumber, CHAR* MessageArgList)
#uselib "ADVAPI32.dll"
#cfunc global TraceMessageVa "TraceMessageVa" int64, int, var, int, var
; res = TraceMessageVa(LoggerHandle, MessageFlags, MessageGuid, MessageNumber, MessageArgList)
; LoggerHandle : ULONGLONG -> "int64"
; MessageFlags : TRACE_MESSAGE_FLAGS -> "int"
; MessageGuid : GUID* -> "var"
; MessageNumber : WORD -> "int"
; MessageArgList : CHAR* -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	advapi32 = windows.NewLazySystemDLL("ADVAPI32.dll")
	procTraceMessageVa = advapi32.NewProc("TraceMessageVa")
)

// LoggerHandle (ULONGLONG), MessageFlags (TRACE_MESSAGE_FLAGS), MessageGuid (GUID*), MessageNumber (WORD), MessageArgList (CHAR*)
r1, _, err := procTraceMessageVa.Call(
	uintptr(LoggerHandle),
	uintptr(MessageFlags),
	uintptr(MessageGuid),
	uintptr(MessageNumber),
	uintptr(MessageArgList),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // WIN32_ERROR
function TraceMessageVa(
  LoggerHandle: UInt64;   // ULONGLONG
  MessageFlags: DWORD;   // TRACE_MESSAGE_FLAGS
  MessageGuid: PGUID;   // GUID*
  MessageNumber: Word;   // WORD
  MessageArgList: Pointer   // CHAR*
): DWORD; stdcall;
  external 'ADVAPI32.dll' name 'TraceMessageVa';
result := DllCall("ADVAPI32\TraceMessageVa"
    , "Int64", LoggerHandle   ; ULONGLONG
    , "UInt", MessageFlags   ; TRACE_MESSAGE_FLAGS
    , "Ptr", MessageGuid   ; GUID*
    , "UShort", MessageNumber   ; WORD
    , "Ptr", MessageArgList   ; CHAR*
    , "UInt")   ; return: WIN32_ERROR
●TraceMessageVa(LoggerHandle, MessageFlags, MessageGuid, MessageNumber, MessageArgList) = DLL("ADVAPI32.dll", "dword TraceMessageVa(qword, dword, void*, int, void*)")
# 呼び出し: TraceMessageVa(LoggerHandle, MessageFlags, MessageGuid, MessageNumber, MessageArgList)
# LoggerHandle : ULONGLONG -> "qword"
# MessageFlags : TRACE_MESSAGE_FLAGS -> "dword"
# MessageGuid : GUID* -> "void*"
# MessageNumber : WORD -> "int"
# MessageArgList : CHAR* -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "advapi32" fn TraceMessageVa(
    LoggerHandle: u64, // ULONGLONG
    MessageFlags: u32, // TRACE_MESSAGE_FLAGS
    MessageGuid: [*c]GUID, // GUID*
    MessageNumber: u16, // WORD
    MessageArgList: [*c]i8 // CHAR*
) callconv(std.os.windows.WINAPI) u32;
proc TraceMessageVa(
    LoggerHandle: uint64,  # ULONGLONG
    MessageFlags: uint32,  # TRACE_MESSAGE_FLAGS
    MessageGuid: ptr GUID,  # GUID*
    MessageNumber: uint16,  # WORD
    MessageArgList: ptr int8  # CHAR*
): uint32 {.importc: "TraceMessageVa", stdcall, dynlib: "ADVAPI32.dll".}
pragma(lib, "advapi32");
extern(Windows)
uint TraceMessageVa(
    ulong LoggerHandle,   // ULONGLONG
    uint MessageFlags,   // TRACE_MESSAGE_FLAGS
    GUID* MessageGuid,   // GUID*
    ushort MessageNumber,   // WORD
    byte* MessageArgList   // CHAR*
);
ccall((:TraceMessageVa, "ADVAPI32.dll"), stdcall, UInt32,
      (UInt64, UInt32, Ptr{GUID}, UInt16, Ptr{Int8}),
      LoggerHandle, MessageFlags, MessageGuid, MessageNumber, MessageArgList)
# LoggerHandle : ULONGLONG -> UInt64
# MessageFlags : TRACE_MESSAGE_FLAGS -> UInt32
# MessageGuid : GUID* -> Ptr{GUID}
# MessageNumber : WORD -> UInt16
# MessageArgList : CHAR* -> Ptr{Int8}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t TraceMessageVa(
    uint64_t LoggerHandle,
    uint32_t MessageFlags,
    void* MessageGuid,
    uint16_t MessageNumber,
    int8_t* MessageArgList);
]]
local advapi32 = ffi.load("advapi32")
-- advapi32.TraceMessageVa(LoggerHandle, MessageFlags, MessageGuid, MessageNumber, MessageArgList)
-- LoggerHandle : ULONGLONG
-- MessageFlags : TRACE_MESSAGE_FLAGS
-- MessageGuid : GUID*
-- MessageNumber : WORD
-- MessageArgList : CHAR*
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('ADVAPI32.dll');
const TraceMessageVa = lib.func('__stdcall', 'TraceMessageVa', 'uint32_t', ['uint64_t', 'uint32_t', 'void *', 'uint16_t', 'int8_t *']);
// TraceMessageVa(LoggerHandle, MessageFlags, MessageGuid, MessageNumber, MessageArgList)
// LoggerHandle : ULONGLONG -> 'uint64_t'
// MessageFlags : TRACE_MESSAGE_FLAGS -> 'uint32_t'
// MessageGuid : GUID* -> 'void *'
// MessageNumber : WORD -> 'uint16_t'
// MessageArgList : CHAR* -> 'int8_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("ADVAPI32.dll", {
  TraceMessageVa: { parameters: ["u64", "u32", "pointer", "u16", "pointer"], result: "u32" },
});
// lib.symbols.TraceMessageVa(LoggerHandle, MessageFlags, MessageGuid, MessageNumber, MessageArgList)
// LoggerHandle : ULONGLONG -> "u64"
// MessageFlags : TRACE_MESSAGE_FLAGS -> "u32"
// MessageGuid : GUID* -> "pointer"
// MessageNumber : WORD -> "u16"
// MessageArgList : CHAR* -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t TraceMessageVa(
    uint64_t LoggerHandle,
    uint32_t MessageFlags,
    void* MessageGuid,
    uint16_t MessageNumber,
    int8_t* MessageArgList);
C, "ADVAPI32.dll");
// $ffi->TraceMessageVa(LoggerHandle, MessageFlags, MessageGuid, MessageNumber, MessageArgList);
// LoggerHandle : ULONGLONG
// MessageFlags : TRACE_MESSAGE_FLAGS
// MessageGuid : GUID*
// MessageNumber : WORD
// MessageArgList : CHAR*
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Advapi32 extends StdCallLibrary {
    Advapi32 INSTANCE = Native.load("advapi32", Advapi32.class);
    int TraceMessageVa(
        long LoggerHandle,   // ULONGLONG
        int MessageFlags,   // TRACE_MESSAGE_FLAGS
        Pointer MessageGuid,   // GUID*
        short MessageNumber,   // WORD
        byte[] MessageArgList   // CHAR*
    );
}
@[Link("advapi32")]
lib LibADVAPI32
  fun TraceMessageVa = TraceMessageVa(
    LoggerHandle : UInt64,   # ULONGLONG
    MessageFlags : UInt32,   # TRACE_MESSAGE_FLAGS
    MessageGuid : GUID*,   # GUID*
    MessageNumber : UInt16,   # WORD
    MessageArgList : Int8*   # CHAR*
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef TraceMessageVaNative = Uint32 Function(Uint64, Uint32, Pointer<Void>, Uint16, Pointer<Int8>);
typedef TraceMessageVaDart = int Function(int, int, Pointer<Void>, int, Pointer<Int8>);
final TraceMessageVa = DynamicLibrary.open('ADVAPI32.dll')
    .lookupFunction<TraceMessageVaNative, TraceMessageVaDart>('TraceMessageVa');
// LoggerHandle : ULONGLONG -> Uint64
// MessageFlags : TRACE_MESSAGE_FLAGS -> Uint32
// MessageGuid : GUID* -> Pointer<Void>
// MessageNumber : WORD -> Uint16
// MessageArgList : CHAR* -> Pointer<Int8>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function TraceMessageVa(
  LoggerHandle: UInt64;   // ULONGLONG
  MessageFlags: DWORD;   // TRACE_MESSAGE_FLAGS
  MessageGuid: PGUID;   // GUID*
  MessageNumber: Word;   // WORD
  MessageArgList: Pointer   // CHAR*
): DWORD; stdcall;
  external 'ADVAPI32.dll' name 'TraceMessageVa';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "TraceMessageVa"
  c_TraceMessageVa :: Word64 -> Word32 -> Ptr () -> Word16 -> Ptr Int8 -> IO Word32
-- LoggerHandle : ULONGLONG -> Word64
-- MessageFlags : TRACE_MESSAGE_FLAGS -> Word32
-- MessageGuid : GUID* -> Ptr ()
-- MessageNumber : WORD -> Word16
-- MessageArgList : CHAR* -> Ptr Int8
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let tracemessageva =
  foreign "TraceMessageVa"
    (uint64_t @-> uint32_t @-> (ptr void) @-> uint16_t @-> (ptr int8_t) @-> returning uint32_t)
(* LoggerHandle : ULONGLONG -> uint64_t *)
(* MessageFlags : TRACE_MESSAGE_FLAGS -> uint32_t *)
(* MessageGuid : GUID* -> (ptr void) *)
(* MessageNumber : WORD -> uint16_t *)
(* MessageArgList : CHAR* -> (ptr int8_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library advapi32 (t "ADVAPI32.dll"))
(cffi:use-foreign-library advapi32)

(cffi:defcfun ("TraceMessageVa" trace-message-va :convention :stdcall) :uint32
  (logger-handle :uint64)   ; ULONGLONG
  (message-flags :uint32)   ; TRACE_MESSAGE_FLAGS
  (message-guid :pointer)   ; GUID*
  (message-number :uint16)   ; WORD
  (message-arg-list :pointer))   ; CHAR*
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $TraceMessageVa = Win32::API::More->new('ADVAPI32',
    'DWORD TraceMessageVa(UINT64 LoggerHandle, DWORD MessageFlags, LPVOID MessageGuid, WORD MessageNumber, LPVOID MessageArgList)');
# my $ret = $TraceMessageVa->Call($LoggerHandle, $MessageFlags, $MessageGuid, $MessageNumber, $MessageArgList);
# LoggerHandle : ULONGLONG -> UINT64
# MessageFlags : TRACE_MESSAGE_FLAGS -> DWORD
# MessageGuid : GUID* -> LPVOID
# MessageNumber : WORD -> WORD
# MessageArgList : CHAR* -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型