ホーム › System.EventLog › EvtGetObjectArraySize

EvtGetObjectArraySize

関数

イベント情報オブジェクト配列の要素数を取得する。

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

シグネチャ

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

BOOL EvtGetObjectArraySize(
    INT_PTR ObjectArray,
    DWORD* ObjectArraySize
);

パラメーター

名前	型	方向	説明
ObjectArray	INT_PTR	in	EvtGetPublisherMetadataProperty 関数が返すオブジェクト配列へのハンドル。
ObjectArraySize	DWORD*	out	配列内の要素の数。

戻り値の型: 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 EvtGetObjectArraySize(
    INT_PTR ObjectArray,
    DWORD* ObjectArraySize
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("wevtapi.dll", SetLastError = true, ExactSpelling = true)]
static extern bool EvtGetObjectArraySize(
    IntPtr ObjectArray,   // INT_PTR
    out uint ObjectArraySize   // DWORD* out
);

<DllImport("wevtapi.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function EvtGetObjectArraySize(
    ObjectArray As IntPtr,   ' INT_PTR
    <Out> ByRef ObjectArraySize As UInteger   ' DWORD* out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' ObjectArray : INT_PTR
' ObjectArraySize : DWORD* out
Declare PtrSafe Function EvtGetObjectArraySize Lib "wevtapi" ( _
    ByVal ObjectArray As LongPtr, _
    ByRef ObjectArraySize As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

EvtGetObjectArraySize = ctypes.windll.wevtapi.EvtGetObjectArraySize
EvtGetObjectArraySize.restype = wintypes.BOOL
EvtGetObjectArraySize.argtypes = [
    ctypes.c_ssize_t,  # ObjectArray : INT_PTR
    ctypes.POINTER(wintypes.DWORD),  # ObjectArraySize : DWORD* out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('wevtapi.dll')
EvtGetObjectArraySize = Fiddle::Function.new(
  lib['EvtGetObjectArraySize'],
  [
    Fiddle::TYPE_INTPTR_T,  # ObjectArray : INT_PTR
    Fiddle::TYPE_VOIDP,  # ObjectArraySize : DWORD* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "wevtapi")]
extern "system" {
    fn EvtGetObjectArraySize(
        ObjectArray: isize,  // INT_PTR
        ObjectArraySize: *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 EvtGetObjectArraySize(IntPtr ObjectArray, out uint ObjectArraySize);
"@
$api = Add-Type -MemberDefinition $sig -Name 'wevtapi_EvtGetObjectArraySize' -Namespace Win32 -PassThru
# $api::EvtGetObjectArraySize(ObjectArray, ObjectArraySize)

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

出力引数:

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