ReadEventLogA

関数

イベントログからレコードを読み取る(ANSI版)。

DLLADVAPI32.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

// ADVAPI32.dll  (ANSI / -A)
#include <windows.h>

BOOL ReadEventLogA(
    HANDLE hEventLog,
    READ_EVENT_LOG_READ_FLAGS dwReadFlags,
    DWORD dwRecordOffset,
    void* lpBuffer,
    DWORD nNumberOfBytesToRead,
    DWORD* pnBytesRead,
    DWORD* pnMinNumberOfBytesNeeded
);

パラメーター

名前

型

方向

説明

hEventLog

HANDLE

読み取るイベントログのハンドル。このハンドルは OpenEventLog 関数が返します。

dwReadFlags

READ_EVENT_LOG_READ_FLAGS

ログファイルの読み取り方法を指定するには、次のフラグ値を使用します。このパラメーターには、次のいずれかの値を含める必要があります(フラグは相互排他的です)。

値	意味
EVENTLOG_SEEK_READ 0x0002	dwRecordOffset パラメーターで指定したレコードから読み取りを開始します。このオプションは、関数がログファイルのサイズを判別できない場合、大きなログファイルでは機能しないことがあります。詳細については、サポート技術情報の記事 177199 を参照してください。
EVENTLOG_SEQUENTIAL_READ 0x0001	レコードを順次読み取ります。これが最初の読み取り操作である場合、最初に読み取られるレコードは EVENTLOG_FORWARDS_READ または EVENTLOG_BACKWARDS_READ フラグによって決まります。

後続の読み取り操作の方向を示すために、次のいずれかのフラグを指定する必要があります(フラグは相互排他的です)。

値	意味
EVENTLOG_FORWARDS_READ 0x0004	ログを時系列順(古いものから新しいもの)に読み取ります。既定値です。
EVENTLOG_BACKWARDS_READ 0x0008	ログを逆時系列順(新しいものから古いもの)に読み取ります。

dwRecordOffset

DWORD

読み取り操作を開始するログエントリのレコード番号。このパラメーターは、dwReadFlags に EVENTLOG_SEEK_READ フラグが含まれている場合を除き、無視されます。

lpBuffer

void*

out

1 つ以上の EVENTLOGRECORD 構造体を受け取る、アプリケーションが割り当てたバッファー。nNumberOfBytesToRead パラメーターが 0 であっても、このパラメーターを NULL にすることはできません。

このバッファーの最大サイズは 0x7ffff バイトです。

nNumberOfBytesToRead

DWORD

lpBuffer バッファーのサイズ(バイト単位)。この関数は、バッファーに収まる数だけログエントリを読み取ります。エントリの一部だけが返されることはありません。

pnBytesRead

DWORD*

out

関数によって読み取られたバイト数を受け取る変数へのポインター。

pnMinNumberOfBytesNeeded

DWORD*

out

lpBuffer バッファーに必要なサイズを受け取る変数へのポインター。この値は、この関数が 0 を返し、かつ GetLastError が ERROR_INSUFFICIENT_BUFFER を返す場合にのみ有効です。

戻り値の型: BOOL

公式ドキュメント

指定したイベントログから、指定した数のエントリを読み取ります。(ANSI)

戻り値

関数が成功すると、戻り値は 0 以外になります。

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

解説(Remarks)

この関数が正常に終了すると、イベントログ内の読み取り位置が、読み取ったレコード数だけ調整されます。

注意このソースに構成されているファイル名は、他のソースに構成されているファイル名と同じである場合があります(複数のソースが 1 つのログのサブキーとして存在できます)。そのため、この関数は複数のソースによってログに記録されたイベントを返すことがあります。

例

例については、 Querying for Event Information を参照してください。

メモ

winbase.h ヘッダーは、ReadEventLog を、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして定義します。エンコーディング非依存のエイリアスの使用を、エンコーディング非依存でないコードと混在させると、不一致が生じ、コンパイルエラーや実行時エラーの原因となることがあります。詳細については、Conventions for Function Prototypes を参照してください。

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

各言語での呼び出し定義

// ADVAPI32.dll  (ANSI / -A)
#include <windows.h>

BOOL ReadEventLogA(
    HANDLE hEventLog,
    READ_EVENT_LOG_READ_FLAGS dwReadFlags,
    DWORD dwRecordOffset,
    void* lpBuffer,
    DWORD nNumberOfBytesToRead,
    DWORD* pnBytesRead,
    DWORD* pnMinNumberOfBytesNeeded
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("ADVAPI32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool ReadEventLogA(
    IntPtr hEventLog,   // HANDLE
    uint dwReadFlags,   // READ_EVENT_LOG_READ_FLAGS
    uint dwRecordOffset,   // DWORD
    IntPtr lpBuffer,   // void* out
    uint nNumberOfBytesToRead,   // DWORD
    out uint pnBytesRead,   // DWORD* out
    out uint pnMinNumberOfBytesNeeded   // DWORD* out
);

<DllImport("ADVAPI32.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function ReadEventLogA(
    hEventLog As IntPtr,   ' HANDLE
    dwReadFlags As UInteger,   ' READ_EVENT_LOG_READ_FLAGS
    dwRecordOffset As UInteger,   ' DWORD
    lpBuffer As IntPtr,   ' void* out
    nNumberOfBytesToRead As UInteger,   ' DWORD
    <Out> ByRef pnBytesRead As UInteger,   ' DWORD* out
    <Out> ByRef pnMinNumberOfBytesNeeded As UInteger   ' DWORD* out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' hEventLog : HANDLE
' dwReadFlags : READ_EVENT_LOG_READ_FLAGS
' dwRecordOffset : DWORD
' lpBuffer : void* out
' nNumberOfBytesToRead : DWORD
' pnBytesRead : DWORD* out
' pnMinNumberOfBytesNeeded : DWORD* out
Declare PtrSafe Function ReadEventLogA Lib "advapi32" ( _
    ByVal hEventLog As LongPtr, _
    ByVal dwReadFlags As Long, _
    ByVal dwRecordOffset As Long, _
    ByVal lpBuffer As LongPtr, _
    ByVal nNumberOfBytesToRead As Long, _
    ByRef pnBytesRead As Long, _
    ByRef pnMinNumberOfBytesNeeded As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

ReadEventLogA = ctypes.windll.advapi32.ReadEventLogA
ReadEventLogA.restype = wintypes.BOOL
ReadEventLogA.argtypes = [
    wintypes.HANDLE,  # hEventLog : HANDLE
    wintypes.DWORD,  # dwReadFlags : READ_EVENT_LOG_READ_FLAGS
    wintypes.DWORD,  # dwRecordOffset : DWORD
    ctypes.POINTER(None),  # lpBuffer : void* out
    wintypes.DWORD,  # nNumberOfBytesToRead : DWORD
    ctypes.POINTER(wintypes.DWORD),  # pnBytesRead : DWORD* out
    ctypes.POINTER(wintypes.DWORD),  # pnMinNumberOfBytesNeeded : DWORD* out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ADVAPI32.dll')
ReadEventLogA = Fiddle::Function.new(
  lib['ReadEventLogA'],
  [
    Fiddle::TYPE_VOIDP,  # hEventLog : HANDLE
    -Fiddle::TYPE_INT,  # dwReadFlags : READ_EVENT_LOG_READ_FLAGS
    -Fiddle::TYPE_INT,  # dwRecordOffset : DWORD
    Fiddle::TYPE_VOIDP,  # lpBuffer : void* out
    -Fiddle::TYPE_INT,  # nNumberOfBytesToRead : DWORD
    Fiddle::TYPE_VOIDP,  # pnBytesRead : DWORD* out
    Fiddle::TYPE_VOIDP,  # pnMinNumberOfBytesNeeded : DWORD* out
  ],
  Fiddle::TYPE_INT)

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

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("ADVAPI32.dll", CharSet = CharSet.Ansi, SetLastError = true)]
public static extern bool ReadEventLogA(IntPtr hEventLog, uint dwReadFlags, uint dwRecordOffset, IntPtr lpBuffer, uint nNumberOfBytesToRead, out uint pnBytesRead, out uint pnMinNumberOfBytesNeeded);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_ReadEventLogA' -Namespace Win32 -PassThru
# $api::ReadEventLogA(hEventLog, dwReadFlags, dwRecordOffset, lpBuffer, nNumberOfBytesToRead, pnBytesRead, pnMinNumberOfBytesNeeded)

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

出力引数:

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