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

EventWriteString

関数
文字列データを含むETWイベントを記録する。
DLLADVAPI32.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

DWORD EventWriteString(
    REGHANDLE RegHandle,
    BYTE Level,
    ULONGLONG Keyword,
    LPCWSTR String
);

パラメーター

名前方向説明
RegHandleREGHANDLEinプロバイダーの登録ハンドル。ハンドルは EventRegister から取得します。 生成されるイベントは、このハンドルに関連付けられた ProviderId を使用します。
LevelBYTEin

イベントの重大度や重要度を表すために使用される 8 ビットの数値。

重要

ProviderId、Level、Keyword は、イベントをフィルター処理するための主要な手段です。 他の種類のフィルター処理も可能ですが、オーバーヘッドははるかに大きくなります。 すべてのイベントには必ず 0 以外の level と keyword を割り当ててください。

イベントの level の詳細については、EVENT_DESCRIPTOR を参照してください。

KeywordULONGLONGin

イベントが属するイベントカテゴリのセットを示すために使用される 64 ビットのビットマスク。

重要

ProviderId、Level、Keyword は、イベントをフィルター処理するための主要な手段です。 他の種類のフィルター処理も可能ですが、オーバーヘッドははるかに大きくなります。 すべてのイベントには必ず 0 以外の level と keyword を割り当ててください。

イベントの keyword の詳細については、EVENT_DESCRIPTOR を参照してください。

StringLPCWSTRinイベントデータとして書き込む NUL 終端文字列。

戻り値の型: DWORD

公式ドキュメント

文字列をデータとして含む ETW イベントを書き込みます。この関数は

戻り値

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

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

解説(Remarks)

この API は有用ではなく、使用すべきではありません。

この API を使用する代わりに、次の代替手段を検討してください。

EventWriteString は、指定された文字列で構成されるデータペイロードを持つイベントを書き込みます。この API は次のコードとほぼ同等です。

EVENT_DESCRIPTOR eventDescriptor;
EVENT_DATA_DESCRIPTOR dataDescriptor;
EventDescCreate(&eventDescriptor, 0, 0, 0, Level, 0, 0, Keyword);
EventDataDescCreate(&dataDescriptor, String, (wcslen(String) + 1) * sizeof(WCHAR));
return EventWrite(RegHandle, &eventDescriptor, 1, &dataDescriptor);

結果として得られるイベントは、EVENT_HEADER_FLAG_STRING_ONLY フラグが設定されている点を除けば、EventWrite によって生成される他のイベントと同じです(イベントフラグについては EVENT_HEADER を参照してください)。

イベントは、ID、Version、Opcode、Task、Channel がすべて 0 に設定された状態で書き込まれることに注意してください。

イベントは現在のスレッドのアクティビティ ID を使用することに注意してください。

EVENT_HEADER_FLAG_STRING_ONLY フラグを認識している ETW 分析ツールは、デコーダーがイベントプロバイダーに関する他のデコード情報を見つけられない場合でも、文字列値を抽出できます。ただし、マニフェストがない場合、これらのツールはイベントのプロバイダー名を特定できません。

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

各言語での呼び出し定義

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

DWORD EventWriteString(
    REGHANDLE RegHandle,
    BYTE Level,
    ULONGLONG Keyword,
    LPCWSTR String
);
[DllImport("ADVAPI32.dll", ExactSpelling = true)]
static extern uint EventWriteString(
    long RegHandle,   // REGHANDLE
    byte Level,   // BYTE
    ulong Keyword,   // ULONGLONG
    [MarshalAs(UnmanagedType.LPWStr)] string String   // LPCWSTR
);
<DllImport("ADVAPI32.dll", ExactSpelling:=True)>
Public Shared Function EventWriteString(
    RegHandle As Long,   ' REGHANDLE
    Level As Byte,   ' BYTE
    Keyword As ULong,   ' ULONGLONG
    <MarshalAs(UnmanagedType.LPWStr)> [String] As String   ' LPCWSTR
) As UInteger
End Function
' RegHandle : REGHANDLE
' Level : BYTE
' Keyword : ULONGLONG
' String : LPCWSTR
Declare PtrSafe Function EventWriteString Lib "advapi32" ( _
    ByVal RegHandle As LongLong, _
    ByVal Level As Byte, _
    ByVal Keyword As LongLong, _
    ByVal String As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

EventWriteString = ctypes.windll.advapi32.EventWriteString
EventWriteString.restype = wintypes.DWORD
EventWriteString.argtypes = [
    ctypes.c_longlong,  # RegHandle : REGHANDLE
    ctypes.c_ubyte,  # Level : BYTE
    ctypes.c_ulonglong,  # Keyword : ULONGLONG
    wintypes.LPCWSTR,  # String : LPCWSTR
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ADVAPI32.dll')
EventWriteString = Fiddle::Function.new(
  lib['EventWriteString'],
  [
    Fiddle::TYPE_LONG_LONG,  # RegHandle : REGHANDLE
    -Fiddle::TYPE_CHAR,  # Level : BYTE
    -Fiddle::TYPE_LONG_LONG,  # Keyword : ULONGLONG
    Fiddle::TYPE_VOIDP,  # String : LPCWSTR
  ],
  -Fiddle::TYPE_INT)
#[link(name = "advapi32")]
extern "system" {
    fn EventWriteString(
        RegHandle: i64,  // REGHANDLE
        Level: u8,  // BYTE
        Keyword: u64,  // ULONGLONG
        String: *const u16  // LPCWSTR
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("ADVAPI32.dll")]
public static extern uint EventWriteString(long RegHandle, byte Level, ulong Keyword, [MarshalAs(UnmanagedType.LPWStr)] string String);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_EventWriteString' -Namespace Win32 -PassThru
# $api::EventWriteString(RegHandle, Level, Keyword, String)
#uselib "ADVAPI32.dll"
#func global EventWriteString "EventWriteString" sptr, sptr, sptr, sptr
; EventWriteString RegHandle, Level, Keyword, String   ; 戻り値は stat
; RegHandle : REGHANDLE -> "sptr"
; Level : BYTE -> "sptr"
; Keyword : ULONGLONG -> "sptr"
; String : LPCWSTR -> "sptr"
; ※HSP3.7は int64 引数(64bit値渡し)に非対応です。
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "ADVAPI32.dll"
#cfunc global EventWriteString "EventWriteString" int64, int, int64, wstr
; res = EventWriteString(RegHandle, Level, Keyword, String)
; RegHandle : REGHANDLE -> "int64"
; Level : BYTE -> "int"
; Keyword : ULONGLONG -> "int64"
; String : LPCWSTR -> "wstr"
; ※int64 引数の DLL 値渡しは x64 ランタイム(hsp3_64)のみ対応(x86 は未対応)。
; DWORD EventWriteString(REGHANDLE RegHandle, BYTE Level, ULONGLONG Keyword, LPCWSTR String)
#uselib "ADVAPI32.dll"
#cfunc global EventWriteString "EventWriteString" int64, int, int64, wstr
; res = EventWriteString(RegHandle, Level, Keyword, String)
; RegHandle : REGHANDLE -> "int64"
; Level : BYTE -> "int"
; Keyword : ULONGLONG -> "int64"
; String : LPCWSTR -> "wstr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	advapi32 = windows.NewLazySystemDLL("ADVAPI32.dll")
	procEventWriteString = advapi32.NewProc("EventWriteString")
)

// RegHandle (REGHANDLE), Level (BYTE), Keyword (ULONGLONG), String (LPCWSTR)
r1, _, err := procEventWriteString.Call(
	uintptr(RegHandle),
	uintptr(Level),
	uintptr(Keyword),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(String))),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function EventWriteString(
  RegHandle: Int64;   // REGHANDLE
  Level: Byte;   // BYTE
  Keyword: UInt64;   // ULONGLONG
  String: PWideChar   // LPCWSTR
): DWORD; stdcall;
  external 'ADVAPI32.dll' name 'EventWriteString';
result := DllCall("ADVAPI32\EventWriteString"
    , "Int64", RegHandle   ; REGHANDLE
    , "UChar", Level   ; BYTE
    , "Int64", Keyword   ; ULONGLONG
    , "WStr", String   ; LPCWSTR
    , "UInt")   ; return: DWORD
●EventWriteString(RegHandle, Level, Keyword, String) = DLL("ADVAPI32.dll", "dword EventWriteString(int64, byte, qword, char*)")
# 呼び出し: EventWriteString(RegHandle, Level, Keyword, String)
# RegHandle : REGHANDLE -> "int64"
# Level : BYTE -> "byte"
# Keyword : ULONGLONG -> "qword"
# String : LPCWSTR -> "char*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "advapi32" fn EventWriteString(
    RegHandle: i64, // REGHANDLE
    Level: u8, // BYTE
    Keyword: u64, // ULONGLONG
    String: [*c]const u16 // LPCWSTR
) callconv(std.os.windows.WINAPI) u32;
proc EventWriteString(
    RegHandle: int64,  # REGHANDLE
    Level: uint8,  # BYTE
    Keyword: uint64,  # ULONGLONG
    String: WideCString  # LPCWSTR
): uint32 {.importc: "EventWriteString", stdcall, dynlib: "ADVAPI32.dll".}
pragma(lib, "advapi32");
extern(Windows)
uint EventWriteString(
    long RegHandle,   // REGHANDLE
    ubyte Level,   // BYTE
    ulong Keyword,   // ULONGLONG
    const(wchar)* String   // LPCWSTR
);
ccall((:EventWriteString, "ADVAPI32.dll"), stdcall, UInt32,
      (Int64, UInt8, UInt64, Cwstring),
      RegHandle, Level, Keyword, String)
# RegHandle : REGHANDLE -> Int64
# Level : BYTE -> UInt8
# Keyword : ULONGLONG -> UInt64
# String : LPCWSTR -> Cwstring
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t EventWriteString(
    int64_t RegHandle,
    uint8_t Level,
    uint64_t Keyword,
    const uint16_t* String);
]]
local advapi32 = ffi.load("advapi32")
-- advapi32.EventWriteString(RegHandle, Level, Keyword, String)
-- RegHandle : REGHANDLE
-- Level : BYTE
-- Keyword : ULONGLONG
-- String : LPCWSTR
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('ADVAPI32.dll');
const EventWriteString = lib.func('__stdcall', 'EventWriteString', 'uint32_t', ['int64_t', 'uint8_t', 'uint64_t', 'str16']);
// EventWriteString(RegHandle, Level, Keyword, String)
// RegHandle : REGHANDLE -> 'int64_t'
// Level : BYTE -> 'uint8_t'
// Keyword : ULONGLONG -> 'uint64_t'
// String : LPCWSTR -> 'str16'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("ADVAPI32.dll", {
  EventWriteString: { parameters: ["i64", "u8", "u64", "buffer"], result: "u32" },
});
// lib.symbols.EventWriteString(RegHandle, Level, Keyword, String)
// RegHandle : REGHANDLE -> "i64"
// Level : BYTE -> "u8"
// Keyword : ULONGLONG -> "u64"
// String : LPCWSTR -> "buffer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t EventWriteString(
    int64_t RegHandle,
    uint8_t Level,
    uint64_t Keyword,
    const uint16_t* String);
C, "ADVAPI32.dll");
// $ffi->EventWriteString(RegHandle, Level, Keyword, String);
// RegHandle : REGHANDLE
// Level : BYTE
// Keyword : ULONGLONG
// String : LPCWSTR
// 構造体/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 EventWriteString(
        long RegHandle,   // REGHANDLE
        byte Level,   // BYTE
        long Keyword,   // ULONGLONG
        WString String   // LPCWSTR
    );
}
@[Link("advapi32")]
lib LibADVAPI32
  fun EventWriteString = EventWriteString(
    RegHandle : Int64,   # REGHANDLE
    Level : UInt8,   # BYTE
    Keyword : UInt64,   # ULONGLONG
    String : UInt16*   # LPCWSTR
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef EventWriteStringNative = Uint32 Function(Int64, Uint8, Uint64, Pointer<Utf16>);
typedef EventWriteStringDart = int Function(int, int, int, Pointer<Utf16>);
final EventWriteString = DynamicLibrary.open('ADVAPI32.dll')
    .lookupFunction<EventWriteStringNative, EventWriteStringDart>('EventWriteString');
// RegHandle : REGHANDLE -> Int64
// Level : BYTE -> Uint8
// Keyword : ULONGLONG -> Uint64
// String : LPCWSTR -> Pointer<Utf16>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function EventWriteString(
  RegHandle: Int64;   // REGHANDLE
  Level: Byte;   // BYTE
  Keyword: UInt64;   // ULONGLONG
  String: PWideChar   // LPCWSTR
): DWORD; stdcall;
  external 'ADVAPI32.dll' name 'EventWriteString';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "EventWriteString"
  c_EventWriteString :: Int64 -> Word8 -> Word64 -> CWString -> IO Word32
-- RegHandle : REGHANDLE -> Int64
-- Level : BYTE -> Word8
-- Keyword : ULONGLONG -> Word64
-- String : LPCWSTR -> CWString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let eventwritestring =
  foreign "EventWriteString"
    (int64_t @-> uint8_t @-> uint64_t @-> (ptr uint16_t) @-> returning uint32_t)
(* RegHandle : REGHANDLE -> int64_t *)
(* Level : BYTE -> uint8_t *)
(* Keyword : ULONGLONG -> uint64_t *)
(* String : LPCWSTR -> (ptr uint16_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library advapi32 (t "ADVAPI32.dll"))
(cffi:use-foreign-library advapi32)

(cffi:defcfun ("EventWriteString" event-write-string :convention :stdcall) :uint32
  (reg-handle :int64)   ; REGHANDLE
  (level :uint8)   ; BYTE
  (keyword :uint64)   ; ULONGLONG
  (string (:string :encoding :utf-16le)))   ; LPCWSTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $EventWriteString = Win32::API::More->new('ADVAPI32',
    'DWORD EventWriteString(INT64 RegHandle, BYTE Level, UINT64 Keyword, LPCWSTR String)');
# my $ret = $EventWriteString->Call($RegHandle, $Level, $Keyword, $String);
# RegHandle : REGHANDLE -> INT64
# Level : BYTE -> BYTE
# Keyword : ULONGLONG -> UINT64
# String : LPCWSTR -> LPCWSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。