ホーム › System.EventLog › GetEventLogInformation

GetEventLogInformation

関数

イベントログに関する情報を取得する。

DLLADVAPI32.dll呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

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

BOOL GetEventLogInformation(
    HANDLE hEventLog,
    DWORD dwInfoLevel,
    void* lpBuffer,
    DWORD cbBufSize,
    DWORD* pcbBytesNeeded
);

パラメーター

名前

型

方向

説明

hEventLog

HANDLE

イベントログへのハンドル。 OpenEventLog 関数または RegisterEventSource 関数がこのハンドルを返します。

dwInfoLevel

DWORD

返すイベントログ情報のレベル。

このパラメーターには次の値を指定できます。

値	意味
EVENTLOG_FULL_INFO	指定されたログが満杯かどうかを示します。lpBuffer パラメーターには EVENTLOG_FULL_INFORMATION 構造体が格納されます。

lpBuffer

void*

out

イベントログ情報を受け取る、アプリケーションが割り当てたバッファー。このデータの形式は dwInfoLevel パラメーターの値によって異なります。

cbBufSize

DWORD

lpBuffer バッファーのサイズ(バイト単位)。

pcbBytesNeeded

DWORD*

out

関数の成否にかかわらず、要求された情報に必要なバッファーサイズがこのパラメーターに設定されます。関数が ERROR_INSUFFICIENT_BUFFER で失敗した場合は、この値を使用して正しいサイズのバッファーを割り当ててください。

戻り値の型: BOOL

公式ドキュメント

指定されたイベントログに関する情報を取得します。

戻り値

関数が成功した場合、戻り値は 0 以外の値です。

関数が失敗した場合、戻り値は 0 です。拡張エラー情報を取得するには、 GetLastError を呼び出します。

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

各言語での呼び出し定義

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

BOOL GetEventLogInformation(
    HANDLE hEventLog,
    DWORD dwInfoLevel,
    void* lpBuffer,
    DWORD cbBufSize,
    DWORD* pcbBytesNeeded
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("ADVAPI32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool GetEventLogInformation(
    IntPtr hEventLog,   // HANDLE
    uint dwInfoLevel,   // DWORD
    IntPtr lpBuffer,   // void* out
    uint cbBufSize,   // DWORD
    out uint pcbBytesNeeded   // DWORD* out
);

<DllImport("ADVAPI32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetEventLogInformation(
    hEventLog As IntPtr,   ' HANDLE
    dwInfoLevel As UInteger,   ' DWORD
    lpBuffer As IntPtr,   ' void* out
    cbBufSize As UInteger,   ' DWORD
    <Out> ByRef pcbBytesNeeded As UInteger   ' DWORD* out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' hEventLog : HANDLE
' dwInfoLevel : DWORD
' lpBuffer : void* out
' cbBufSize : DWORD
' pcbBytesNeeded : DWORD* out
Declare PtrSafe Function GetEventLogInformation Lib "advapi32" ( _
    ByVal hEventLog As LongPtr, _
    ByVal dwInfoLevel As Long, _
    ByVal lpBuffer As LongPtr, _
    ByVal cbBufSize As Long, _
    ByRef pcbBytesNeeded As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GetEventLogInformation = ctypes.windll.advapi32.GetEventLogInformation
GetEventLogInformation.restype = wintypes.BOOL
GetEventLogInformation.argtypes = [
    wintypes.HANDLE,  # hEventLog : HANDLE
    wintypes.DWORD,  # dwInfoLevel : DWORD
    ctypes.POINTER(None),  # lpBuffer : void* out
    wintypes.DWORD,  # cbBufSize : DWORD
    ctypes.POINTER(wintypes.DWORD),  # pcbBytesNeeded : DWORD* out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ADVAPI32.dll')
GetEventLogInformation = Fiddle::Function.new(
  lib['GetEventLogInformation'],
  [
    Fiddle::TYPE_VOIDP,  # hEventLog : HANDLE
    -Fiddle::TYPE_INT,  # dwInfoLevel : DWORD
    Fiddle::TYPE_VOIDP,  # lpBuffer : void* out
    -Fiddle::TYPE_INT,  # cbBufSize : DWORD
    Fiddle::TYPE_VOIDP,  # pcbBytesNeeded : DWORD* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "advapi32")]
extern "system" {
    fn GetEventLogInformation(
        hEventLog: *mut core::ffi::c_void,  // HANDLE
        dwInfoLevel: u32,  // DWORD
        lpBuffer: *mut (),  // void* out
        cbBufSize: u32,  // DWORD
        pcbBytesNeeded: *mut u32  // DWORD* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("ADVAPI32.dll", SetLastError = true)]
public static extern bool GetEventLogInformation(IntPtr hEventLog, uint dwInfoLevel, IntPtr lpBuffer, uint cbBufSize, out uint pcbBytesNeeded);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_GetEventLogInformation' -Namespace Win32 -PassThru
# $api::GetEventLogInformation(hEventLog, dwInfoLevel, lpBuffer, cbBufSize, pcbBytesNeeded)

#uselib "ADVAPI32.dll"
#func global GetEventLogInformation "GetEventLogInformation" sptr, sptr, sptr, sptr, sptr
; GetEventLogInformation hEventLog, dwInfoLevel, lpBuffer, cbBufSize, varptr(pcbBytesNeeded)   ; 戻り値は stat
; hEventLog : HANDLE -> "sptr"
; dwInfoLevel : DWORD -> "sptr"
; lpBuffer : void* out -> "sptr"
; cbBufSize : DWORD -> "sptr"
; pcbBytesNeeded : DWORD* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "ADVAPI32.dll"
#cfunc global GetEventLogInformation "GetEventLogInformation" sptr, int, sptr, int, var
; res = GetEventLogInformation(hEventLog, dwInfoLevel, lpBuffer, cbBufSize, pcbBytesNeeded)
; hEventLog : HANDLE -> "sptr"
; dwInfoLevel : DWORD -> "int"
; lpBuffer : void* out -> "sptr"
; cbBufSize : DWORD -> "int"
; pcbBytesNeeded : DWORD* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "ADVAPI32.dll"
#cfunc global GetEventLogInformation "GetEventLogInformation" sptr, int, sptr, int, sptr
; res = GetEventLogInformation(hEventLog, dwInfoLevel, lpBuffer, cbBufSize, varptr(pcbBytesNeeded))
; hEventLog : HANDLE -> "sptr"
; dwInfoLevel : DWORD -> "int"
; lpBuffer : void* out -> "sptr"
; cbBufSize : DWORD -> "int"
; pcbBytesNeeded : DWORD* out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。