EvtRender

関数

イベントをXMLまたは値配列にレンダリングする。

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

シグネチャ

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

BOOL EvtRender(
    EVT_HANDLE Context,   // optional
    EVT_HANDLE Fragment,
    DWORD Flags,
    DWORD BufferSize,
    void* Buffer,   // optional
    DWORD* BufferUsed,
    DWORD* PropertyCount
);

パラメーター

名前	型	方向	説明
Context	EVT_HANDLE	inoptional	EvtCreateRenderContext 関数が返すレンダリングコンテキストへのハンドルです。Flags パラメーターに EvtRenderEventXml または EvtRenderBookmark が設定されている場合、このパラメーターは NULL に設定する必要があります。
Fragment	EVT_HANDLE	in	イベントまたはブックマークへのハンドルです。Flags パラメーターに EvtRenderBookmark が設定されている場合はブックマークハンドルを設定し、それ以外の場合はイベントハンドルを設定します。
Flags	DWORD	in	レンダリングする対象を指定するフラグです。たとえば、イベント全体やイベントの特定のプロパティなどです。指定可能な値については、EVT_RENDER_FLAGS 列挙型を参照してください。
BufferSize	DWORD	in	Buffer バッファーのサイズ(バイト単位)です。
Buffer	void*	outoptional	レンダリング結果を受け取る、呼び出し元が割り当てたバッファーです。Flags パラメーターに EvtRenderEventXml または EvtRenderBookmark が設定されている場合、内容は null で終端された Unicode 文字列になります。一方、Flags に EvtRenderEventValues が設定されている場合、バッファーには EVT_VARIANT 構造体の配列が格納され、レンダリングコンテキストで指定された各プロパティに対して 1 つの構造体が含まれます。PropertyCount パラメーターには配列の要素数が格納されます。必要なバッファーサイズを確認するために、このパラメーターを NULL に設定できます。
BufferUsed	DWORD*	out	関数が使用した、呼び出し元が割り当てたバッファーのサイズ(バイト単位)です。関数が ERROR_INSUFFICIENT_BUFFER で失敗した場合は、必要なバッファーサイズが格納されます。
PropertyCount	DWORD*	out	Flags パラメーターに EvtRenderEventValues が設定されている場合は Buffer パラメーター内のプロパティ数、それ以外の場合はゼロです。

戻り値の型: BOOL

公式ドキュメント

指定したレンダリングコンテキストに基づいて XML フラグメントをレンダリングします。

戻り値

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

解説(Remarks)

EvtCreateRenderContext 関数を呼び出したときに指定した XPath 式の配列と、バッファーに返される値の配列との間には 1 対 1 の対応関係があります。

この関数で得た EVT_HANDLE を EvtRender 関数で使用すると、その関数が返す値のリストは EVT_VARIANT 構造体の配列となり、各構造体は元の ValuePaths パラメーター配列の XPATH 式に出現順で 1 対 1 で対応します。各 EVT_VARIANT 構造体には、レンダリング対象のイベントについて、対応する XPATH 式で識別される値が格納されます。値が見つからない場合、EVT_VARIANT 構造体には NULL が格納されます。複数の値が存在する場合、EVT_VARIANT 構造体には最初に見つかった値が格納されます。

XPath クエリで浮動小数点数を比較する際は注意してください。浮動小数点数の文字列表現はすべて近似値であるため、XML に表示される値がイベントと共に格納された数値と一致しない場合があります。浮動小数点数は、定数より小さいか大きいかという形で比較してください。

例

この関数の使用方法を示す例については、Rendering Events および Bookmarking Events を参照してください。

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

各言語での呼び出し定義

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

BOOL EvtRender(
    EVT_HANDLE Context,   // optional
    EVT_HANDLE Fragment,
    DWORD Flags,
    DWORD BufferSize,
    void* Buffer,   // optional
    DWORD* BufferUsed,
    DWORD* PropertyCount
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("wevtapi.dll", SetLastError = true, ExactSpelling = true)]
static extern bool EvtRender(
    IntPtr Context,   // EVT_HANDLE optional
    IntPtr Fragment,   // EVT_HANDLE
    uint Flags,   // DWORD
    uint BufferSize,   // DWORD
    IntPtr Buffer,   // void* optional, out
    out uint BufferUsed,   // DWORD* out
    out uint PropertyCount   // DWORD* out
);

<DllImport("wevtapi.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function EvtRender(
    Context As IntPtr,   ' EVT_HANDLE optional
    Fragment As IntPtr,   ' EVT_HANDLE
    Flags As UInteger,   ' DWORD
    BufferSize As UInteger,   ' DWORD
    Buffer As IntPtr,   ' void* optional, out
    <Out> ByRef BufferUsed As UInteger,   ' DWORD* out
    <Out> ByRef PropertyCount As UInteger   ' DWORD* out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' Context : EVT_HANDLE optional
' Fragment : EVT_HANDLE
' Flags : DWORD
' BufferSize : DWORD
' Buffer : void* optional, out
' BufferUsed : DWORD* out
' PropertyCount : DWORD* out
Declare PtrSafe Function EvtRender Lib "wevtapi" ( _
    ByVal Context As LongPtr, _
    ByVal Fragment As LongPtr, _
    ByVal Flags As Long, _
    ByVal BufferSize As Long, _
    ByVal Buffer As LongPtr, _
    ByRef BufferUsed As Long, _
    ByRef PropertyCount As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

EvtRender = ctypes.windll.wevtapi.EvtRender
EvtRender.restype = wintypes.BOOL
EvtRender.argtypes = [
    ctypes.c_ssize_t,  # Context : EVT_HANDLE optional
    ctypes.c_ssize_t,  # Fragment : EVT_HANDLE
    wintypes.DWORD,  # Flags : DWORD
    wintypes.DWORD,  # BufferSize : DWORD
    ctypes.POINTER(None),  # Buffer : void* optional, out
    ctypes.POINTER(wintypes.DWORD),  # BufferUsed : DWORD* out
    ctypes.POINTER(wintypes.DWORD),  # PropertyCount : DWORD* out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('wevtapi.dll')
EvtRender = Fiddle::Function.new(
  lib['EvtRender'],
  [
    Fiddle::TYPE_INTPTR_T,  # Context : EVT_HANDLE optional
    Fiddle::TYPE_INTPTR_T,  # Fragment : EVT_HANDLE
    -Fiddle::TYPE_INT,  # Flags : DWORD
    -Fiddle::TYPE_INT,  # BufferSize : DWORD
    Fiddle::TYPE_VOIDP,  # Buffer : void* optional, out
    Fiddle::TYPE_VOIDP,  # BufferUsed : DWORD* out
    Fiddle::TYPE_VOIDP,  # PropertyCount : DWORD* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "wevtapi")]
extern "system" {
    fn EvtRender(
        Context: isize,  // EVT_HANDLE optional
        Fragment: isize,  // EVT_HANDLE
        Flags: u32,  // DWORD
        BufferSize: u32,  // DWORD
        Buffer: *mut (),  // void* optional, out
        BufferUsed: *mut u32,  // DWORD* out
        PropertyCount: *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 EvtRender(IntPtr Context, IntPtr Fragment, uint Flags, uint BufferSize, IntPtr Buffer, out uint BufferUsed, out uint PropertyCount);
"@
$api = Add-Type -MemberDefinition $sig -Name 'wevtapi_EvtRender' -Namespace Win32 -PassThru
# $api::EvtRender(Context, Fragment, Flags, BufferSize, Buffer, BufferUsed, PropertyCount)

#uselib "wevtapi.dll"
#func global EvtRender "EvtRender" sptr, sptr, sptr, sptr, sptr, sptr, sptr
; EvtRender Context, Fragment, Flags, BufferSize, Buffer, varptr(BufferUsed), varptr(PropertyCount)   ; 戻り値は stat
; Context : EVT_HANDLE optional -> "sptr"
; Fragment : EVT_HANDLE -> "sptr"
; Flags : DWORD -> "sptr"
; BufferSize : DWORD -> "sptr"
; Buffer : void* optional, out -> "sptr"
; BufferUsed : DWORD* out -> "sptr"
; PropertyCount : DWORD* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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