EvtGetEventInfo

関数

イベントの情報プロパティを取得する。

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

シグネチャ

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

BOOL EvtGetEventInfo(
    EVT_HANDLE Event,
    EVT_EVENT_PROPERTY_ID PropertyId,
    DWORD PropertyValueBufferSize,
    EVT_VARIANT* PropertyValueBuffer,   // optional
    DWORD* PropertyValueBufferUsed
);

パラメーター

名前	型	方向	説明
Event	EVT_HANDLE	in	情報を取得する対象のイベントへのハンドル。
PropertyId	EVT_EVENT_PROPERTY_ID	in	取得する情報を識別するフラグ。たとえば、クエリ識別子やパスなどです。指定可能な値については、EVT_EVENT_PROPERTY_ID 列挙型を参照してください。
PropertyValueBufferSize	DWORD	in	PropertyValueBuffer バッファのサイズ(バイト単位)。
PropertyValueBuffer	EVT_VARIANT*	outoptional	情報を受け取る、呼び出し元が割り当てたバッファ。このバッファには EVT_VARIANT オブジェクトが格納されます。必要なバッファサイズを判別するには、このパラメーターを NULL に設定できます。
PropertyValueBufferUsed	DWORD*	out	関数が使用した、呼び出し元が割り当てたバッファのサイズ(バイト単位)。関数が ERROR_INSUFFICIENT_BUFFER で失敗した場合は、必要なバッファサイズになります。

戻り値の型: BOOL

公式ドキュメント

イベントを選択した構造化 XML クエリと、そのイベントを格納しているチャネルまたはログファイルを識別する情報を取得します。

戻り値

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

解説(Remarks)

EvtQuery または EvtSubscribe に渡したクエリが、構造化 XML クエリではなく XPath であった場合、クエリ識別子は 0 になり、パスは関数に渡したパスになります。

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

各言語での呼び出し定義

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

BOOL EvtGetEventInfo(
    EVT_HANDLE Event,
    EVT_EVENT_PROPERTY_ID PropertyId,
    DWORD PropertyValueBufferSize,
    EVT_VARIANT* PropertyValueBuffer,   // optional
    DWORD* PropertyValueBufferUsed
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("wevtapi.dll", SetLastError = true, ExactSpelling = true)]
static extern bool EvtGetEventInfo(
    IntPtr Event,   // EVT_HANDLE
    int PropertyId,   // EVT_EVENT_PROPERTY_ID
    uint PropertyValueBufferSize,   // DWORD
    IntPtr PropertyValueBuffer,   // EVT_VARIANT* optional, out
    out uint PropertyValueBufferUsed   // DWORD* out
);

<DllImport("wevtapi.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function EvtGetEventInfo(
    [Event] As IntPtr,   ' EVT_HANDLE
    PropertyId As Integer,   ' EVT_EVENT_PROPERTY_ID
    PropertyValueBufferSize As UInteger,   ' DWORD
    PropertyValueBuffer As IntPtr,   ' EVT_VARIANT* optional, out
    <Out> ByRef PropertyValueBufferUsed As UInteger   ' DWORD* out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' Event : EVT_HANDLE
' PropertyId : EVT_EVENT_PROPERTY_ID
' PropertyValueBufferSize : DWORD
' PropertyValueBuffer : EVT_VARIANT* optional, out
' PropertyValueBufferUsed : DWORD* out
Declare PtrSafe Function EvtGetEventInfo Lib "wevtapi" ( _
    ByVal Event As LongPtr, _
    ByVal PropertyId As Long, _
    ByVal PropertyValueBufferSize As Long, _
    ByVal PropertyValueBuffer As LongPtr, _
    ByRef PropertyValueBufferUsed As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

EvtGetEventInfo = ctypes.windll.wevtapi.EvtGetEventInfo
EvtGetEventInfo.restype = wintypes.BOOL
EvtGetEventInfo.argtypes = [
    ctypes.c_ssize_t,  # Event : EVT_HANDLE
    ctypes.c_int,  # PropertyId : EVT_EVENT_PROPERTY_ID
    wintypes.DWORD,  # PropertyValueBufferSize : DWORD
    ctypes.c_void_p,  # PropertyValueBuffer : EVT_VARIANT* optional, out
    ctypes.POINTER(wintypes.DWORD),  # PropertyValueBufferUsed : DWORD* out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('wevtapi.dll')
EvtGetEventInfo = Fiddle::Function.new(
  lib['EvtGetEventInfo'],
  [
    Fiddle::TYPE_INTPTR_T,  # Event : EVT_HANDLE
    Fiddle::TYPE_INT,  # PropertyId : EVT_EVENT_PROPERTY_ID
    -Fiddle::TYPE_INT,  # PropertyValueBufferSize : DWORD
    Fiddle::TYPE_VOIDP,  # PropertyValueBuffer : EVT_VARIANT* optional, out
    Fiddle::TYPE_VOIDP,  # PropertyValueBufferUsed : DWORD* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "wevtapi")]
extern "system" {
    fn EvtGetEventInfo(
        Event: isize,  // EVT_HANDLE
        PropertyId: i32,  // EVT_EVENT_PROPERTY_ID
        PropertyValueBufferSize: u32,  // DWORD
        PropertyValueBuffer: *mut EVT_VARIANT,  // EVT_VARIANT* optional, out
        PropertyValueBufferUsed: *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 EvtGetEventInfo(IntPtr Event, int PropertyId, uint PropertyValueBufferSize, IntPtr PropertyValueBuffer, out uint PropertyValueBufferUsed);
"@
$api = Add-Type -MemberDefinition $sig -Name 'wevtapi_EvtGetEventInfo' -Namespace Win32 -PassThru
# $api::EvtGetEventInfo(Event, PropertyId, PropertyValueBufferSize, PropertyValueBuffer, PropertyValueBufferUsed)

#uselib "wevtapi.dll"
#func global EvtGetEventInfo "EvtGetEventInfo" sptr, sptr, sptr, sptr, sptr
; EvtGetEventInfo Event, PropertyId, PropertyValueBufferSize, varptr(PropertyValueBuffer), varptr(PropertyValueBufferUsed)   ; 戻り値は stat
; Event : EVT_HANDLE -> "sptr"
; PropertyId : EVT_EVENT_PROPERTY_ID -> "sptr"
; PropertyValueBufferSize : DWORD -> "sptr"
; PropertyValueBuffer : EVT_VARIANT* optional, out -> "sptr"
; PropertyValueBufferUsed : DWORD* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "wevtapi.dll"
#cfunc global EvtGetEventInfo "EvtGetEventInfo" sptr, int, int, var, var
; res = EvtGetEventInfo(Event, PropertyId, PropertyValueBufferSize, PropertyValueBuffer, PropertyValueBufferUsed)
; Event : EVT_HANDLE -> "sptr"
; PropertyId : EVT_EVENT_PROPERTY_ID -> "int"
; PropertyValueBufferSize : DWORD -> "int"
; PropertyValueBuffer : EVT_VARIANT* optional, out -> "var"
; PropertyValueBufferUsed : DWORD* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "wevtapi.dll"
#cfunc global EvtGetEventInfo "EvtGetEventInfo" sptr, int, int, sptr, sptr
; res = EvtGetEventInfo(Event, PropertyId, PropertyValueBufferSize, varptr(PropertyValueBuffer), varptr(PropertyValueBufferUsed))
; Event : EVT_HANDLE -> "sptr"
; PropertyId : EVT_EVENT_PROPERTY_ID -> "int"
; PropertyValueBufferSize : DWORD -> "int"
; PropertyValueBuffer : EVT_VARIANT* optional, out -> "sptr"
; PropertyValueBufferUsed : DWORD* out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。