ホーム › 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
);

パラメーター

名前	型	方向	説明
ObjectArray	INT_PTR	in	EvtGetPublisherMetadataProperty 関数が返すオブジェクト配列へのハンドル。
PropertyId	DWORD	in	指定したオブジェクトから取得するメタデータプロパティのプロパティ識別子。指定可能な値については、EVT_PUBLISHER_METADATA_PROPERTY_ID の「解説」セクションを参照してください。
ArrayIndex	DWORD	in	配列内のオブジェクトの 0 から始まるインデックス。
Flags	DWORD	in	予約済み。0 を指定する必要があります。
PropertyValueBufferSize	DWORD	in	PropertyValueBuffer バッファーのサイズ(バイト単位)。
PropertyValueBuffer	EVT_VARIANT*	outoptional	メタデータプロパティを受け取る、呼び出し元が割り当てたバッファー。このバッファーには EVT_VARIANT オブジェクトが格納されます。必要なバッファーサイズを判定するには、このパラメーターに NULL を設定できます。
PropertyValueBufferUsed	DWORD*	out	関数が使用した、呼び出し元が割り当てたバッファーのサイズ(バイト単位)。関数が ERROR_INSUFFICIENT_BUFFER で失敗した場合は、必要なバッファーサイズ。

戻り値の型: BOOL

公式ドキュメント

配列内の指定したオブジェクトからプロバイダーメタデータプロパティを取得します。

戻り値

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

解説(Remarks)

EvtGetPublisherMetadataProperty 関数を次の ID で呼び出すと、その型のオブジェクト配列へのハンドルが返されます。

EvtPublisherMetadataChannelReferences
EvtPublisherMetadataLevels
EvtPublisherMetadataTasks
EvtPublisherMetadataOpcodes
EvtPublisherMetadataKeywords

例えば、EvtPublisherMetadataKeywords を EvtGetPublisherMetadataProperty に渡すと、キーワードオブジェクトの配列へのハンドルが返されます。

配列のサイズを判定するには、EvtGetObjectArraySize 関数を呼び出します。

例

この関数の使用方法を示す例については、Getting a Provider's Metadata を参照してください。

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

各言語での呼び出し定義

// 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 <MarshalAs(UnmanagedType.Bool)> 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 方式にも切替可。#uselib "wevtapi.dll"
#cfunc global EvtGetObjectArrayProperty "EvtGetObjectArrayProperty" sptr, int, int, int, int, sptr, sptr
; res = EvtGetObjectArrayProperty(ObjectArray, PropertyId, ArrayIndex, Flags, PropertyValueBufferSize, varptr(PropertyValueBuffer), varptr(PropertyValueBufferUsed))
; ObjectArray : INT_PTR -> "sptr"
; PropertyId : DWORD -> "int"
; ArrayIndex : DWORD -> "int"
; Flags : DWORD -> "int"
; PropertyValueBufferSize : DWORD -> "int"
; PropertyValueBuffer : EVT_VARIANT* optional, out -> "sptr"
; PropertyValueBufferUsed : DWORD* out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。