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

EvtGetObjectArrayProperty

関数
イベント情報オブジェクト配列のプロパティを取得する。
DLLwevtapi.dll呼出規約winapiSetLastErrorあり対応OSWindows Vista 以降

シグネチャ

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

BOOL EvtGetObjectArrayProperty(
    INT_PTR ObjectArray,
    DWORD PropertyId,
    DWORD ArrayIndex,
    DWORD Flags,
    DWORD PropertyValueBufferSize,
    EVT_VARIANT* PropertyValueBuffer,   // optional
    DWORD* PropertyValueBufferUsed
);

パラメーター

名前方向
ObjectArrayINT_PTRin
PropertyIdDWORDin
ArrayIndexDWORDin
FlagsDWORDin
PropertyValueBufferSizeDWORDin
PropertyValueBufferEVT_VARIANT*outoptional
PropertyValueBufferUsedDWORD*out

戻り値の型: BOOL

各言語での呼び出し定義

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

BOOL EvtGetObjectArrayProperty(
    INT_PTR ObjectArray,
    DWORD PropertyId,
    DWORD ArrayIndex,
    DWORD Flags,
    DWORD PropertyValueBufferSize,
    EVT_VARIANT* PropertyValueBuffer,   // optional
    DWORD* PropertyValueBufferUsed
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("wevtapi.dll", SetLastError = true, ExactSpelling = true)]
static extern bool EvtGetObjectArrayProperty(
    IntPtr ObjectArray,   // INT_PTR
    uint PropertyId,   // DWORD
    uint ArrayIndex,   // DWORD
    uint Flags,   // DWORD
    uint PropertyValueBufferSize,   // DWORD
    IntPtr PropertyValueBuffer,   // EVT_VARIANT* optional, out
    out uint PropertyValueBufferUsed   // DWORD* out
);
<DllImport("wevtapi.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function EvtGetObjectArrayProperty(
    ObjectArray As IntPtr,   ' INT_PTR
    PropertyId As UInteger,   ' DWORD
    ArrayIndex As UInteger,   ' DWORD
    Flags As UInteger,   ' DWORD
    PropertyValueBufferSize As UInteger,   ' DWORD
    PropertyValueBuffer As IntPtr,   ' EVT_VARIANT* optional, out
    <Out> ByRef PropertyValueBufferUsed As UInteger   ' DWORD* out
) As Boolean
End Function
' ObjectArray : INT_PTR
' PropertyId : DWORD
' ArrayIndex : DWORD
' Flags : DWORD
' PropertyValueBufferSize : DWORD
' PropertyValueBuffer : EVT_VARIANT* optional, out
' PropertyValueBufferUsed : DWORD* out
Declare PtrSafe Function EvtGetObjectArrayProperty Lib "wevtapi" ( _
    ByVal ObjectArray As LongPtr, _
    ByVal PropertyId As Long, _
    ByVal ArrayIndex As Long, _
    ByVal Flags 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

EvtGetObjectArrayProperty = ctypes.windll.wevtapi.EvtGetObjectArrayProperty
EvtGetObjectArrayProperty.restype = wintypes.BOOL
EvtGetObjectArrayProperty.argtypes = [
    ctypes.c_ssize_t,  # ObjectArray : INT_PTR
    wintypes.DWORD,  # PropertyId : DWORD
    wintypes.DWORD,  # ArrayIndex : DWORD
    wintypes.DWORD,  # Flags : DWORD
    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')
EvtGetObjectArrayProperty = Fiddle::Function.new(
  lib['EvtGetObjectArrayProperty'],
  [
    Fiddle::TYPE_INTPTR_T,  # ObjectArray : INT_PTR
    -Fiddle::TYPE_INT,  # PropertyId : DWORD
    -Fiddle::TYPE_INT,  # ArrayIndex : DWORD
    -Fiddle::TYPE_INT,  # Flags : DWORD
    -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 EvtGetObjectArrayProperty(
        ObjectArray: isize,  // INT_PTR
        PropertyId: u32,  // DWORD
        ArrayIndex: u32,  // DWORD
        Flags: u32,  // DWORD
        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 EvtGetObjectArrayProperty(IntPtr ObjectArray, uint PropertyId, uint ArrayIndex, uint Flags, uint PropertyValueBufferSize, IntPtr PropertyValueBuffer, out uint PropertyValueBufferUsed);
"@
$api = Add-Type -MemberDefinition $sig -Name 'wevtapi_EvtGetObjectArrayProperty' -Namespace Win32 -PassThru
# $api::EvtGetObjectArrayProperty(ObjectArray, PropertyId, ArrayIndex, Flags, PropertyValueBufferSize, PropertyValueBuffer, PropertyValueBufferUsed)
#uselib "wevtapi.dll"
#func global EvtGetObjectArrayProperty "EvtGetObjectArrayProperty" sptr, sptr, sptr, sptr, sptr, sptr, sptr
; EvtGetObjectArrayProperty ObjectArray, PropertyId, ArrayIndex, Flags, PropertyValueBufferSize, varptr(PropertyValueBuffer), varptr(PropertyValueBufferUsed)   ; 戻り値は stat
; ObjectArray : INT_PTR -> "sptr"
; PropertyId : DWORD -> "sptr"
; ArrayIndex : DWORD -> "sptr"
; Flags : DWORD -> "sptr"
; PropertyValueBufferSize : DWORD -> "sptr"
; PropertyValueBuffer : EVT_VARIANT* optional, out -> "sptr"
; PropertyValueBufferUsed : DWORD* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "wevtapi.dll"
#cfunc global EvtGetObjectArrayProperty "EvtGetObjectArrayProperty" sptr, int, int, int, int, var, var
; res = EvtGetObjectArrayProperty(ObjectArray, PropertyId, ArrayIndex, Flags, PropertyValueBufferSize, PropertyValueBuffer, PropertyValueBufferUsed)
; ObjectArray : INT_PTR -> "sptr"
; PropertyId : DWORD -> "int"
; ArrayIndex : DWORD -> "int"
; Flags : DWORD -> "int"
; PropertyValueBufferSize : DWORD -> "int"
; PropertyValueBuffer : EVT_VARIANT* optional, out -> "var"
; PropertyValueBufferUsed : DWORD* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOL EvtGetObjectArrayProperty(INT_PTR ObjectArray, DWORD PropertyId, DWORD ArrayIndex, DWORD Flags, DWORD PropertyValueBufferSize, EVT_VARIANT* PropertyValueBuffer, DWORD* PropertyValueBufferUsed)
#uselib "wevtapi.dll"
#cfunc global EvtGetObjectArrayProperty "EvtGetObjectArrayProperty" intptr, int, int, int, int, var, var
; res = EvtGetObjectArrayProperty(ObjectArray, PropertyId, ArrayIndex, Flags, PropertyValueBufferSize, PropertyValueBuffer, PropertyValueBufferUsed)
; ObjectArray : INT_PTR -> "intptr"
; PropertyId : DWORD -> "int"
; ArrayIndex : DWORD -> "int"
; Flags : DWORD -> "int"
; PropertyValueBufferSize : DWORD -> "int"
; PropertyValueBuffer : EVT_VARIANT* optional, out -> "var"
; PropertyValueBufferUsed : DWORD* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	wevtapi = windows.NewLazySystemDLL("wevtapi.dll")
	procEvtGetObjectArrayProperty = wevtapi.NewProc("EvtGetObjectArrayProperty")
)

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