ホーム › System.EventLog › GetOldestEventLogRecord

GetOldestEventLogRecord

関数

イベントログの最も古いレコード番号を取得する。

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

シグネチャ

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

BOOL GetOldestEventLogRecord(
    HANDLE hEventLog,
    DWORD* OldestRecord
);

パラメーター

名前	型	方向	説明
hEventLog	HANDLE	in	オープン済みのイベントログへのハンドル。このハンドルは OpenEventLog 関数または OpenBackupEventLog 関数が返します。
OldestRecord	DWORD*	out	指定したイベントログ内で最も古いレコードの絶対レコード番号を受け取る変数へのポインター。

戻り値の型: BOOL

公式ドキュメント

指定したイベントログ内で最も古いレコードの絶対レコード番号を取得します。

戻り値

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

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

解説(Remarks)

イベントログ内で最も古いレコードは、必ずしもレコード番号 1 とは限りません。詳細については、 Event Log Records を参照してください。

Examples

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

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

各言語での呼び出し定義

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

BOOL GetOldestEventLogRecord(
    HANDLE hEventLog,
    DWORD* OldestRecord
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("ADVAPI32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool GetOldestEventLogRecord(
    IntPtr hEventLog,   // HANDLE
    out uint OldestRecord   // DWORD* out
);

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

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

import ctypes
from ctypes import wintypes

GetOldestEventLogRecord = ctypes.windll.advapi32.GetOldestEventLogRecord
GetOldestEventLogRecord.restype = wintypes.BOOL
GetOldestEventLogRecord.argtypes = [
    wintypes.HANDLE,  # hEventLog : HANDLE
    ctypes.POINTER(wintypes.DWORD),  # OldestRecord : DWORD* out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ADVAPI32.dll')
GetOldestEventLogRecord = Fiddle::Function.new(
  lib['GetOldestEventLogRecord'],
  [
    Fiddle::TYPE_VOIDP,  # hEventLog : HANDLE
    Fiddle::TYPE_VOIDP,  # OldestRecord : DWORD* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "advapi32")]
extern "system" {
    fn GetOldestEventLogRecord(
        hEventLog: *mut core::ffi::c_void,  // HANDLE
        OldestRecord: *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 GetOldestEventLogRecord(IntPtr hEventLog, out uint OldestRecord);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_GetOldestEventLogRecord' -Namespace Win32 -PassThru
# $api::GetOldestEventLogRecord(hEventLog, OldestRecord)

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

出力引数:

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