ホーム › 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	EvtOpenPublisherMetadata 関数が返すプロバイダーのメタデータへのハンドルです。このハンドルは、イベントまたはメッセージ識別子の整形コンテキストとして機能します。 Windows イベントコレクターサービスがイベントを転送した場合は、このパラメーターに NULL を設定できます。転送されたイベントには、整形済みのメッセージ文字列を含む RenderingInfo セクションが含まれます。また、整形対象のイベントプロパティが Winmeta.xml ファイル内で定義されている場合(たとえば level が win:Error に設定されている場合)にも、このパラメーターに NULL を設定できます。後者の場合、サービスは Winmeta プロバイダーを整形コンテキストとして使用し、Winmeta.xml ファイル内で定義されイベントから参照されているメッセージ文字列のみを整形します。
Event	EVT_HANDLE	inoptional	イベントへのハンドルです。Flags パラメーターは、整形対象とするイベント内のメッセージ文字列を指定します。Flags パラメーターが EvtFormatMessageId に設定されている場合、このパラメーターは NULL でなければなりません。
MessageId	DWORD	in	整形対象とするメッセージ文字列のリソース識別子です。メッセージ文字列のリソース識別子を取得するには、GetPublisherMetadataProperty 関数を呼び出します。このパラメーターは、Flags パラメーターが EvtFormatMessageId に設定されている場合にのみ設定します。
ValueCount	DWORD	in	Values パラメーター内の値の数です。
Values	EVT_VARIANT*	inoptional	イベントのメッセージ文字列を整形する際に使用する挿入値の配列です。通常、このパラメーターには NULL を設定し、関数はイベントデータ自体から挿入値を取得します。既定の動作を上書きして使用する挿入値を指定したい場合に、このパラメーターを使用します。たとえば、値を挿入する前に SID をプリンシパル名へ解決したい場合などに使用できます。挿入値を上書きするには、Flags パラメーターを EvtFormatMessageEvent、EvtFormatMessageXML、または EvtFormatMessageId に設定する必要があります。Flags が EvtFormatMessageId に設定されている場合、リソース識別子はイベントのメッセージ文字列を識別するものでなければなりません。
Flags	DWORD	in	整形対象とするイベント内のメッセージ文字列を指定するフラグです。指定可能な値については、EVT_FORMAT_MESSAGE_FLAGS 列挙型を参照してください。
BufferSize	DWORD	in	Buffer バッファーのサイズ(文字数)です。
Buffer	LPWSTR	outoptional	整形済みのメッセージ文字列を受け取る、呼び出し側が割り当てたバッファーです。必要なバッファーサイズを調べるには、このパラメーターに NULL を設定できます。
BufferUsed	DWORD*	out	関数が使用した、呼び出し側が割り当てたバッファーのサイズ(文字数)、または関数が ERROR_INSUFFICIENT_BUFFER で失敗した場合は必要なバッファーサイズです。

戻り値の型: BOOL

公式ドキュメント

メッセージ文字列を整形します。(EvtFormatMessage)

戻り値

戻り値	説明
TRUE	関数は成功しました。
FALSE	関数は失敗しました。エラーコードを取得するには GetLastError 関数を呼び出してください。

解説(Remarks)

サービスがイベントのメッセージを検索する際、PublisherMetadata パラメーターで指定されたパブリッシャーのメッセージテーブルリソースを参照します。メッセージ ID が見つかった後、以下の検索アルゴリズムが使用されます。

イベントメッセージの場合:

provider 要素の messageFileName 属性で指定されたファイルを検索します。
見つからない場合は、システムメッセージを検索します。

event 要素の Level、Opcode、Keyword 属性の場合:

Winmeta プロバイダーのリソースを検索します。
provider 要素の messageFileName 属性で指定されたファイルを検索します。

event 要素の Task 属性の場合:

provider 要素の messageFileName 属性で指定されたファイルを検索します。
見つからない場合は、Winmeta プロバイダーのリソースを検索します。

イベントメッセージ内で %%n(n はメッセージ ID)として参照されるローカライズ可能なパラメーターの場合:

provider 要素の parameterFileName 属性に列挙されたファイルを左から右へ検索します。
見つからない場合は、システムメッセージを検索します。

例

この関数の使用方法を示す例については、Formatting Event Messages および Getting a Provider's Metadata を参照してください。

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

各言語での呼び出し定義

// 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 <MarshalAs(UnmanagedType.Bool)> 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(変数))。