ホーム › System.EventLog › EvtGetEventMetadataProperty

EvtGetEventMetadataProperty

関数

イベントメタデータのプロパティを取得する。

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

シグネチャ

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

BOOL EvtGetEventMetadataProperty(
    EVT_HANDLE EventMetadata,
    EVT_EVENT_METADATA_PROPERTY_ID PropertyId,
    DWORD Flags,
    DWORD EventMetadataPropertyBufferSize,
    EVT_VARIANT* EventMetadataPropertyBuffer,   // optional
    DWORD* EventMetadataPropertyBufferUsed
);

パラメーター

名前	型	方向	説明
EventMetadata	EVT_HANDLE	in	EvtNextEventMetadata 関数が返すイベントメタデータのハンドルです。
PropertyId	EVT_EVENT_METADATA_PROPERTY_ID	in	取得するメタデータプロパティの識別子です。プロパティ識別子の一覧については、EVT_EVENT_METADATA_PROPERTY_ID 列挙体を参照してください。
Flags	DWORD	in	予約されています。ゼロを指定する必要があります。
EventMetadataPropertyBufferSize	DWORD	in	EventMetadataPropertyBuffer バッファのサイズ(バイト単位)です。
EventMetadataPropertyBuffer	EVT_VARIANT*	outoptional	メタデータプロパティを受け取る、呼び出し側が割り当てたバッファです。このバッファには EVT_VARIANT オブジェクトが格納されます。必要なバッファサイズを求めるには、このパラメーターに NULL を指定できます。
EventMetadataPropertyBufferUsed	DWORD*	out	関数が使用した、呼び出し側が割り当てたバッファのサイズ(バイト単位)です。関数が ERROR_INSUFFICIENT_BUFFER で失敗した場合は、必要なバッファサイズが格納されます。

戻り値の型: BOOL

公式ドキュメント

指定したイベントメタデータプロパティを取得します。

戻り値

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

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

各言語での呼び出し定義

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

BOOL EvtGetEventMetadataProperty(
    EVT_HANDLE EventMetadata,
    EVT_EVENT_METADATA_PROPERTY_ID PropertyId,
    DWORD Flags,
    DWORD EventMetadataPropertyBufferSize,
    EVT_VARIANT* EventMetadataPropertyBuffer,   // optional
    DWORD* EventMetadataPropertyBufferUsed
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("wevtapi.dll", SetLastError = true, ExactSpelling = true)]
static extern bool EvtGetEventMetadataProperty(
    IntPtr EventMetadata,   // EVT_HANDLE
    int PropertyId,   // EVT_EVENT_METADATA_PROPERTY_ID
    uint Flags,   // DWORD
    uint EventMetadataPropertyBufferSize,   // DWORD
    IntPtr EventMetadataPropertyBuffer,   // EVT_VARIANT* optional, out
    out uint EventMetadataPropertyBufferUsed   // DWORD* out
);

<DllImport("wevtapi.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function EvtGetEventMetadataProperty(
    EventMetadata As IntPtr,   ' EVT_HANDLE
    PropertyId As Integer,   ' EVT_EVENT_METADATA_PROPERTY_ID
    Flags As UInteger,   ' DWORD
    EventMetadataPropertyBufferSize As UInteger,   ' DWORD
    EventMetadataPropertyBuffer As IntPtr,   ' EVT_VARIANT* optional, out
    <Out> ByRef EventMetadataPropertyBufferUsed As UInteger   ' DWORD* out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' EventMetadata : EVT_HANDLE
' PropertyId : EVT_EVENT_METADATA_PROPERTY_ID
' Flags : DWORD
' EventMetadataPropertyBufferSize : DWORD
' EventMetadataPropertyBuffer : EVT_VARIANT* optional, out
' EventMetadataPropertyBufferUsed : DWORD* out
Declare PtrSafe Function EvtGetEventMetadataProperty Lib "wevtapi" ( _
    ByVal EventMetadata As LongPtr, _
    ByVal PropertyId As Long, _
    ByVal Flags As Long, _
    ByVal EventMetadataPropertyBufferSize As Long, _
    ByVal EventMetadataPropertyBuffer As LongPtr, _
    ByRef EventMetadataPropertyBufferUsed As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

EvtGetEventMetadataProperty = ctypes.windll.wevtapi.EvtGetEventMetadataProperty
EvtGetEventMetadataProperty.restype = wintypes.BOOL
EvtGetEventMetadataProperty.argtypes = [
    ctypes.c_ssize_t,  # EventMetadata : EVT_HANDLE
    ctypes.c_int,  # PropertyId : EVT_EVENT_METADATA_PROPERTY_ID
    wintypes.DWORD,  # Flags : DWORD
    wintypes.DWORD,  # EventMetadataPropertyBufferSize : DWORD
    ctypes.c_void_p,  # EventMetadataPropertyBuffer : EVT_VARIANT* optional, out
    ctypes.POINTER(wintypes.DWORD),  # EventMetadataPropertyBufferUsed : DWORD* out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('wevtapi.dll')
EvtGetEventMetadataProperty = Fiddle::Function.new(
  lib['EvtGetEventMetadataProperty'],
  [
    Fiddle::TYPE_INTPTR_T,  # EventMetadata : EVT_HANDLE
    Fiddle::TYPE_INT,  # PropertyId : EVT_EVENT_METADATA_PROPERTY_ID
    -Fiddle::TYPE_INT,  # Flags : DWORD
    -Fiddle::TYPE_INT,  # EventMetadataPropertyBufferSize : DWORD
    Fiddle::TYPE_VOIDP,  # EventMetadataPropertyBuffer : EVT_VARIANT* optional, out
    Fiddle::TYPE_VOIDP,  # EventMetadataPropertyBufferUsed : DWORD* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "wevtapi")]
extern "system" {
    fn EvtGetEventMetadataProperty(
        EventMetadata: isize,  // EVT_HANDLE
        PropertyId: i32,  // EVT_EVENT_METADATA_PROPERTY_ID
        Flags: u32,  // DWORD
        EventMetadataPropertyBufferSize: u32,  // DWORD
        EventMetadataPropertyBuffer: *mut EVT_VARIANT,  // EVT_VARIANT* optional, out
        EventMetadataPropertyBufferUsed: *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 EvtGetEventMetadataProperty(IntPtr EventMetadata, int PropertyId, uint Flags, uint EventMetadataPropertyBufferSize, IntPtr EventMetadataPropertyBuffer, out uint EventMetadataPropertyBufferUsed);
"@
$api = Add-Type -MemberDefinition $sig -Name 'wevtapi_EvtGetEventMetadataProperty' -Namespace Win32 -PassThru
# $api::EvtGetEventMetadataProperty(EventMetadata, PropertyId, Flags, EventMetadataPropertyBufferSize, EventMetadataPropertyBuffer, EventMetadataPropertyBufferUsed)

#uselib "wevtapi.dll"
#func global EvtGetEventMetadataProperty "EvtGetEventMetadataProperty" sptr, sptr, sptr, sptr, sptr, sptr
; EvtGetEventMetadataProperty EventMetadata, PropertyId, Flags, EventMetadataPropertyBufferSize, varptr(EventMetadataPropertyBuffer), varptr(EventMetadataPropertyBufferUsed)   ; 戻り値は stat
; EventMetadata : EVT_HANDLE -> "sptr"
; PropertyId : EVT_EVENT_METADATA_PROPERTY_ID -> "sptr"
; Flags : DWORD -> "sptr"
; EventMetadataPropertyBufferSize : DWORD -> "sptr"
; EventMetadataPropertyBuffer : EVT_VARIANT* optional, out -> "sptr"
; EventMetadataPropertyBufferUsed : DWORD* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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