ホーム › System.EventLog › EvtFormatMessage

EvtFormatMessage

関数

イベントのメッセージ文字列を整形して取得する。

DLLwevtapi.dll呼出規約winapiSetLastErrorあり対応OSWindows Vista 以降

シグネチャ

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

BOOL EvtFormatMessage(
    EVT_HANDLE PublisherMetadata,   // optional
    EVT_HANDLE Event,   // optional
    DWORD MessageId,
    DWORD ValueCount,
    EVT_VARIANT* Values,   // optional
    DWORD Flags,
    DWORD BufferSize,
    LPWSTR Buffer,   // optional
    DWORD* BufferUsed
);

パラメーター

名前	型	方向
PublisherMetadata	EVT_HANDLE	inoptional
Event	EVT_HANDLE	inoptional
MessageId	DWORD	in
ValueCount	DWORD	in
Values	EVT_VARIANT*	inoptional
Flags	DWORD	in
BufferSize	DWORD	in
Buffer	LPWSTR	outoptional
BufferUsed	DWORD*	out

戻り値の型: BOOL

各言語での呼び出し定義

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

BOOL EvtFormatMessage(
    EVT_HANDLE PublisherMetadata,   // optional
    EVT_HANDLE Event,   // optional
    DWORD MessageId,
    DWORD ValueCount,
    EVT_VARIANT* Values,   // optional
    DWORD Flags,
    DWORD BufferSize,
    LPWSTR Buffer,   // optional
    DWORD* BufferUsed
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("wevtapi.dll", SetLastError = true, ExactSpelling = true)]
static extern bool EvtFormatMessage(
    IntPtr PublisherMetadata,   // EVT_HANDLE optional
    IntPtr Event,   // EVT_HANDLE optional
    uint MessageId,   // DWORD
    uint ValueCount,   // DWORD
    IntPtr Values,   // EVT_VARIANT* optional
    uint Flags,   // DWORD
    uint BufferSize,   // DWORD
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder Buffer,   // LPWSTR optional, out
    out uint BufferUsed   // DWORD* out
);

<DllImport("wevtapi.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function EvtFormatMessage(
    PublisherMetadata As IntPtr,   ' EVT_HANDLE optional
    [Event] As IntPtr,   ' EVT_HANDLE optional
    MessageId As UInteger,   ' DWORD
    ValueCount As UInteger,   ' DWORD
    Values As IntPtr,   ' EVT_VARIANT* optional
    Flags As UInteger,   ' DWORD
    BufferSize As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPWStr)> Buffer As System.Text.StringBuilder,   ' LPWSTR optional, out
    <Out> ByRef BufferUsed As UInteger   ' DWORD* out
) As Boolean
End Function

' PublisherMetadata : EVT_HANDLE optional
' Event : EVT_HANDLE optional
' MessageId : DWORD
' ValueCount : DWORD
' Values : EVT_VARIANT* optional
' Flags : DWORD
' BufferSize : DWORD
' Buffer : LPWSTR optional, out
' BufferUsed : DWORD* out
Declare PtrSafe Function EvtFormatMessage Lib "wevtapi" ( _
    ByVal PublisherMetadata As LongPtr, _
    ByVal Event As LongPtr, _
    ByVal MessageId As Long, _
    ByVal ValueCount As Long, _
    ByVal Values As LongPtr, _
    ByVal Flags As Long, _
    ByVal BufferSize As Long, _
    ByVal Buffer As LongPtr, _
    ByRef BufferUsed As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

EvtFormatMessage = ctypes.windll.wevtapi.EvtFormatMessage
EvtFormatMessage.restype = wintypes.BOOL
EvtFormatMessage.argtypes = [
    ctypes.c_ssize_t,  # PublisherMetadata : EVT_HANDLE optional
    ctypes.c_ssize_t,  # Event : EVT_HANDLE optional
    wintypes.DWORD,  # MessageId : DWORD
    wintypes.DWORD,  # ValueCount : DWORD
    ctypes.c_void_p,  # Values : EVT_VARIANT* optional
    wintypes.DWORD,  # Flags : DWORD
    wintypes.DWORD,  # BufferSize : DWORD
    wintypes.LPWSTR,  # Buffer : LPWSTR optional, out
    ctypes.POINTER(wintypes.DWORD),  # BufferUsed : DWORD* out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('wevtapi.dll')
EvtFormatMessage = Fiddle::Function.new(
  lib['EvtFormatMessage'],
  [
    Fiddle::TYPE_INTPTR_T,  # PublisherMetadata : EVT_HANDLE optional
    Fiddle::TYPE_INTPTR_T,  # Event : EVT_HANDLE optional
    -Fiddle::TYPE_INT,  # MessageId : DWORD
    -Fiddle::TYPE_INT,  # ValueCount : DWORD
    Fiddle::TYPE_VOIDP,  # Values : EVT_VARIANT* optional
    -Fiddle::TYPE_INT,  # Flags : DWORD
    -Fiddle::TYPE_INT,  # BufferSize : DWORD
    Fiddle::TYPE_VOIDP,  # Buffer : LPWSTR optional, out
    Fiddle::TYPE_VOIDP,  # BufferUsed : DWORD* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "wevtapi")]
extern "system" {
    fn EvtFormatMessage(
        PublisherMetadata: isize,  // EVT_HANDLE optional
        Event: isize,  // EVT_HANDLE optional
        MessageId: u32,  // DWORD
        ValueCount: u32,  // DWORD
        Values: *mut EVT_VARIANT,  // EVT_VARIANT* optional
        Flags: u32,  // DWORD
        BufferSize: u32,  // DWORD
        Buffer: *mut u16,  // LPWSTR optional, out
        BufferUsed: *mut u32  // DWORD* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("wevtapi.dll", SetLastError = true)]
public static extern bool EvtFormatMessage(IntPtr PublisherMetadata, IntPtr Event, uint MessageId, uint ValueCount, IntPtr Values, uint Flags, uint BufferSize, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder Buffer, out uint BufferUsed);
"@
$api = Add-Type -MemberDefinition $sig -Name 'wevtapi_EvtFormatMessage' -Namespace Win32 -PassThru
# $api::EvtFormatMessage(PublisherMetadata, Event, MessageId, ValueCount, Values, Flags, BufferSize, Buffer, BufferUsed)

#uselib "wevtapi.dll"
#func global EvtFormatMessage "EvtFormatMessage" sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr
; EvtFormatMessage PublisherMetadata, Event, MessageId, ValueCount, varptr(Values), Flags, BufferSize, varptr(Buffer), varptr(BufferUsed)   ; 戻り値は stat
; PublisherMetadata : EVT_HANDLE optional -> "sptr"
; Event : EVT_HANDLE optional -> "sptr"
; MessageId : DWORD -> "sptr"
; ValueCount : DWORD -> "sptr"
; Values : EVT_VARIANT* optional -> "sptr"
; Flags : DWORD -> "sptr"
; BufferSize : DWORD -> "sptr"
; Buffer : LPWSTR optional, out -> "sptr"
; BufferUsed : DWORD* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "wevtapi.dll"
#cfunc global EvtFormatMessage "EvtFormatMessage" sptr, sptr, int, int, var, int, int, var, var
; res = EvtFormatMessage(PublisherMetadata, Event, MessageId, ValueCount, Values, Flags, BufferSize, Buffer, BufferUsed)
; PublisherMetadata : EVT_HANDLE optional -> "sptr"
; Event : EVT_HANDLE optional -> "sptr"
; MessageId : DWORD -> "int"
; ValueCount : DWORD -> "int"
; Values : EVT_VARIANT* optional -> "var"
; Flags : DWORD -> "int"
; BufferSize : DWORD -> "int"
; Buffer : LPWSTR optional, out -> "var"
; BufferUsed : DWORD* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "wevtapi.dll"
#cfunc global EvtFormatMessage "EvtFormatMessage" sptr, sptr, int, int, sptr, int, int, sptr, sptr
; res = EvtFormatMessage(PublisherMetadata, Event, MessageId, ValueCount, varptr(Values), Flags, BufferSize, varptr(Buffer), varptr(BufferUsed))
; PublisherMetadata : EVT_HANDLE optional -> "sptr"
; Event : EVT_HANDLE optional -> "sptr"
; MessageId : DWORD -> "int"
; ValueCount : DWORD -> "int"
; Values : EVT_VARIANT* optional -> "sptr"
; Flags : DWORD -> "int"
; BufferSize : DWORD -> "int"
; Buffer : LPWSTR optional, out -> "sptr"
; BufferUsed : DWORD* out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。

出力引数:

; BOOL EvtFormatMessage(EVT_HANDLE PublisherMetadata, EVT_HANDLE Event, DWORD MessageId, DWORD ValueCount, EVT_VARIANT* Values, DWORD Flags, DWORD BufferSize, LPWSTR Buffer, DWORD* BufferUsed)
#uselib "wevtapi.dll"
#cfunc global EvtFormatMessage "EvtFormatMessage" intptr, intptr, int, int, var, int, int, var, var
; res = EvtFormatMessage(PublisherMetadata, Event, MessageId, ValueCount, Values, Flags, BufferSize, Buffer, BufferUsed)
; PublisherMetadata : EVT_HANDLE optional -> "intptr"
; Event : EVT_HANDLE optional -> "intptr"
; MessageId : DWORD -> "int"
; ValueCount : DWORD -> "int"
; Values : EVT_VARIANT* optional -> "var"
; Flags : DWORD -> "int"
; BufferSize : DWORD -> "int"
; Buffer : LPWSTR optional, out -> "var"
; BufferUsed : DWORD* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; BOOL EvtFormatMessage(EVT_HANDLE PublisherMetadata, EVT_HANDLE Event, DWORD MessageId, DWORD ValueCount, EVT_VARIANT* Values, DWORD Flags, DWORD BufferSize, LPWSTR Buffer, DWORD* BufferUsed)
#uselib "wevtapi.dll"
#cfunc global EvtFormatMessage "EvtFormatMessage" intptr, intptr, int, int, intptr, int, int, intptr, intptr
; res = EvtFormatMessage(PublisherMetadata, Event, MessageId, ValueCount, varptr(Values), Flags, BufferSize, varptr(Buffer), varptr(BufferUsed))
; PublisherMetadata : EVT_HANDLE optional -> "intptr"
; Event : EVT_HANDLE optional -> "intptr"
; MessageId : DWORD -> "int"
; ValueCount : DWORD -> "int"
; Values : EVT_VARIANT* optional -> "intptr"
; Flags : DWORD -> "int"
; BufferSize : DWORD -> "int"
; Buffer : LPWSTR optional, out -> "intptr"
; BufferUsed : DWORD* out -> "intptr"
; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。

import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	wevtapi = windows.NewLazySystemDLL("wevtapi.dll")
	procEvtFormatMessage = wevtapi.NewProc("EvtFormatMessage")
)

// PublisherMetadata (EVT_HANDLE optional), Event (EVT_HANDLE optional), MessageId (DWORD), ValueCount (DWORD), Values (EVT_VARIANT* optional), Flags (DWORD), BufferSize (DWORD), Buffer (LPWSTR optional, out), BufferUsed (DWORD* out)
r1, _, err := procEvtFormatMessage.Call(
	uintptr(PublisherMetadata),
	uintptr(Event),
	uintptr(MessageId),
	uintptr(ValueCount),
	uintptr(Values),
	uintptr(Flags),
	uintptr(BufferSize),
	uintptr(Buffer),
	uintptr(BufferUsed),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL

function EvtFormatMessage(
  PublisherMetadata: NativeInt;   // EVT_HANDLE optional
  Event: NativeInt;   // EVT_HANDLE optional
  MessageId: DWORD;   // DWORD
  ValueCount: DWORD;   // DWORD
  Values: Pointer;   // EVT_VARIANT* optional
  Flags: DWORD;   // DWORD
  BufferSize: DWORD;   // DWORD
  Buffer: PWideChar;   // LPWSTR optional, out
  BufferUsed: Pointer   // DWORD* out
): BOOL; stdcall;
  external 'wevtapi.dll' name 'EvtFormatMessage';

result := DllCall("wevtapi\EvtFormatMessage"
    , "Ptr", PublisherMetadata   ; EVT_HANDLE optional
    , "Ptr", Event   ; EVT_HANDLE optional
    , "UInt", MessageId   ; DWORD
    , "UInt", ValueCount   ; DWORD
    , "Ptr", Values   ; EVT_VARIANT* optional
    , "UInt", Flags   ; DWORD
    , "UInt", BufferSize   ; DWORD
    , "Ptr", Buffer   ; LPWSTR optional, out
    , "Ptr", BufferUsed   ; DWORD* out
    , "Int")   ; return: BOOL

●EvtFormatMessage(PublisherMetadata, Event, MessageId, ValueCount, Values, Flags, BufferSize, Buffer, BufferUsed) = DLL("wevtapi.dll", "bool EvtFormatMessage(int, int, dword, dword, void*, dword, dword, char*, void*)")
# 呼び出し: EvtFormatMessage(PublisherMetadata, Event, MessageId, ValueCount, Values, Flags, BufferSize, Buffer, BufferUsed)
# PublisherMetadata : EVT_HANDLE optional -> "int"
# Event : EVT_HANDLE optional -> "int"
# MessageId : DWORD -> "dword"
# ValueCount : DWORD -> "dword"
# Values : EVT_VARIANT* optional -> "void*"
# Flags : DWORD -> "dword"
# BufferSize : DWORD -> "dword"
# Buffer : LPWSTR optional, out -> "char*"
# BufferUsed : DWORD* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。