ホーム › System.EventLog › EvtCreateRenderContext

EvtCreateRenderContext

関数

イベントレンダリング用のコンテキストを作成する。

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

シグネチャ

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

EVT_HANDLE EvtCreateRenderContext(
    DWORD ValuePathsCount,
    LPCWSTR* ValuePaths,   // optional
    DWORD Flags
);

パラメーター

名前	型	方向	説明
ValuePathsCount	DWORD	in	ValuePaths パラメーターに含まれる XPath 式の数。
ValuePaths	LPCWSTR*	inoptional	レンダリングするイベント内のノードまたは属性を一意に識別する XPath 式の配列。 Flags パラメーターに EvtRenderContextValues コンテキストフラグが設定されていない場合は NULL を設定します。式に OR 演算子または AND 演算子を含めることはできません。式中の属性名の後にスペースを続けてはいけません。
Flags	DWORD	in	レンダリングするイベント内の情報を識別するフラグ。たとえば、システム情報、ユーザー情報、または特定の値などです。指定可能な値については、EVT_RENDER_CONTEXT_FLAGS 列挙型を参照してください。

名前

型

方向

説明

ValuePathsCount

DWORD

ValuePaths パラメーターに含まれる XPath 式の数。

ValuePaths

LPCWSTR*

inoptional

レンダリングするイベント内のノードまたは属性を一意に識別する XPath 式の配列。

Flags パラメーターに EvtRenderContextValues コンテキストフラグが設定されていない場合は NULL を設定します。

式に OR 演算子または AND 演算子を含めることはできません。

式中の属性名の後にスペースを続けてはいけません。

Flags

DWORD

レンダリングするイベント内の情報を識別するフラグ。たとえば、システム情報、ユーザー情報、または特定の値などです。指定可能な値については、EVT_RENDER_CONTEXT_FLAGS 列挙型を参照してください。

戻り値の型: EVT_HANDLE

公式ドキュメント

レンダリングするイベント内の情報を指定するコンテキストを作成します。

戻り値

イベントの内容をレンダリングするために EvtRender 関数を呼び出す際に使用するコンテキストハンドル。それ以外の場合は NULL。NULL の場合は、GetLastError 関数を呼び出してエラーコードを取得してください。

解説(Remarks)

イベントから指定した情報をレンダリングするには、EvtRender 関数を呼び出します。

処理が完了したら、EvtClose 関数を呼び出してハンドルを閉じる必要があります。

例

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

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

各言語での呼び出し定義

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

EVT_HANDLE EvtCreateRenderContext(
    DWORD ValuePathsCount,
    LPCWSTR* ValuePaths,   // optional
    DWORD Flags
);

[DllImport("wevtapi.dll", SetLastError = true, ExactSpelling = true)]
static extern IntPtr EvtCreateRenderContext(
    uint ValuePathsCount,   // DWORD
    IntPtr ValuePaths,   // LPCWSTR* optional
    uint Flags   // DWORD
);

<DllImport("wevtapi.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function EvtCreateRenderContext(
    ValuePathsCount As UInteger,   ' DWORD
    ValuePaths As IntPtr,   ' LPCWSTR* optional
    Flags As UInteger   ' DWORD
) As IntPtr
End Function

' ValuePathsCount : DWORD
' ValuePaths : LPCWSTR* optional
' Flags : DWORD
Declare PtrSafe Function EvtCreateRenderContext Lib "wevtapi" ( _
    ByVal ValuePathsCount As Long, _
    ByVal ValuePaths As LongPtr, _
    ByVal Flags As Long) As LongPtr
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

EvtCreateRenderContext = ctypes.windll.wevtapi.EvtCreateRenderContext
EvtCreateRenderContext.restype = ctypes.c_ssize_t
EvtCreateRenderContext.argtypes = [
    wintypes.DWORD,  # ValuePathsCount : DWORD
    ctypes.c_void_p,  # ValuePaths : LPCWSTR* optional
    wintypes.DWORD,  # Flags : DWORD
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('wevtapi.dll')
EvtCreateRenderContext = Fiddle::Function.new(
  lib['EvtCreateRenderContext'],
  [
    -Fiddle::TYPE_INT,  # ValuePathsCount : DWORD
    Fiddle::TYPE_VOIDP,  # ValuePaths : LPCWSTR* optional
    -Fiddle::TYPE_INT,  # Flags : DWORD
  ],
  Fiddle::TYPE_INTPTR_T)

#[link(name = "wevtapi")]
extern "system" {
    fn EvtCreateRenderContext(
        ValuePathsCount: u32,  // DWORD
        ValuePaths: *const *const u16,  // LPCWSTR* optional
        Flags: u32  // DWORD
    ) -> isize;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("wevtapi.dll", SetLastError = true)]
public static extern IntPtr EvtCreateRenderContext(uint ValuePathsCount, IntPtr ValuePaths, uint Flags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'wevtapi_EvtCreateRenderContext' -Namespace Win32 -PassThru
# $api::EvtCreateRenderContext(ValuePathsCount, ValuePaths, Flags)

#uselib "wevtapi.dll"
#func global EvtCreateRenderContext "EvtCreateRenderContext" sptr, sptr, sptr
; EvtCreateRenderContext ValuePathsCount, varptr(ValuePaths), Flags   ; 戻り値は stat
; ValuePathsCount : DWORD -> "sptr"
; ValuePaths : LPCWSTR* optional -> "sptr"
; Flags : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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