Win32 API 日本語リファレンス
ホーム › System.EventLog › EvtRender

EvtRender

関数
イベントをXMLまたは値配列にレンダリングする。
DLLwevtapi.dll呼出規約winapiSetLastErrorあり対応OSWindows Vista 以降
📘 Microsoft Learn (日本語) · English

シグネチャ

// 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
);

パラメーター

名前型方向説明
ContextEVT_HANDLEinoptionalEvtCreateRenderContextで作成したコンテキストのEVT_HANDLE。XML出力時はNULL可。
FragmentEVT_HANDLEinレンダリング対象のイベントやブックマークのEVT_HANDLE。
FlagsDWORDin出力形式を示すEVT_RENDER_FLAGS。XML文字列か値配列かを指定する。
BufferSizeDWORDinBufferのサイズをバイト単位で指定する。必要量問い合わせ時は0可。
Buffervoid*outoptionalレンダリング結果を格納するバッファ。NULL可で必要量取得に使う。
BufferUsedDWORD*out実際に使用された、または必要なバイト数を受け取る出力ポインタ。
PropertyCountDWORD*out値配列出力時に返されるプロパティ数を受け取る出力ポインタ。

戻り値の型: BOOL

各言語での呼び出し定義

// 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 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 方式にも切替可。
出力引数: 
; BOOL EvtRender(EVT_HANDLE Context, EVT_HANDLE Fragment, DWORD Flags, DWORD BufferSize, void* Buffer, DWORD* BufferUsed, DWORD* PropertyCount)
#uselib "wevtapi.dll"
#cfunc global EvtRender "EvtRender" intptr, intptr, int, int, intptr, var, var
; res = EvtRender(Context, Fragment, Flags, BufferSize, Buffer, BufferUsed, PropertyCount)
; Context : EVT_HANDLE optional -> "intptr"
; Fragment : EVT_HANDLE -> "intptr"
; Flags : DWORD -> "int"
; BufferSize : DWORD -> "int"
; Buffer : void* optional, out -> "intptr"
; BufferUsed : DWORD* out -> "var"
; PropertyCount : DWORD* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	wevtapi = windows.NewLazySystemDLL("wevtapi.dll")
	procEvtRender = wevtapi.NewProc("EvtRender")
)

// Context (EVT_HANDLE optional), Fragment (EVT_HANDLE), Flags (DWORD), BufferSize (DWORD), Buffer (void* optional, out), BufferUsed (DWORD* out), PropertyCount (DWORD* out)
r1, _, err := procEvtRender.Call(
	uintptr(Context),
	uintptr(Fragment),
	uintptr(Flags),
	uintptr(BufferSize),
	uintptr(Buffer),
	uintptr(BufferUsed),
	uintptr(PropertyCount),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function EvtRender(
  Context: NativeInt;   // EVT_HANDLE optional
  Fragment: NativeInt;   // EVT_HANDLE
  Flags: DWORD;   // DWORD
  BufferSize: DWORD;   // DWORD
  Buffer: Pointer;   // void* optional, out
  BufferUsed: Pointer;   // DWORD* out
  PropertyCount: Pointer   // DWORD* out
): BOOL; stdcall;
  external 'wevtapi.dll' name 'EvtRender';
result := DllCall("wevtapi\EvtRender"
    , "Ptr", Context   ; EVT_HANDLE optional
    , "Ptr", Fragment   ; EVT_HANDLE
    , "UInt", Flags   ; DWORD
    , "UInt", BufferSize   ; DWORD
    , "Ptr", Buffer   ; void* optional, out
    , "Ptr", BufferUsed   ; DWORD* out
    , "Ptr", PropertyCount   ; DWORD* out
    , "Int")   ; return: BOOL
●EvtRender(Context, Fragment, Flags, BufferSize, Buffer, BufferUsed, PropertyCount) = DLL("wevtapi.dll", "bool EvtRender(int, int, dword, dword, void*, void*, void*)")
# 呼び出し: EvtRender(Context, Fragment, Flags, BufferSize, Buffer, BufferUsed, PropertyCount)
# Context : EVT_HANDLE optional -> "int"
# Fragment : EVT_HANDLE -> "int"
# Flags : DWORD -> "dword"
# BufferSize : DWORD -> "dword"
# Buffer : void* optional, out -> "void*"
# BufferUsed : DWORD* out -> "void*"
# PropertyCount : DWORD* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。