Reads the specified number of entries from the specified event log. The function can be used to read log entries in chronological or reverse chronological order.
BOOL ReadEventLogA( HANDLE hEventLog, DWORD dwReadFlags, DWORD dwRecordOffset, LPVOID lpBuffer, DWORD nNumberOfBytesToRead, DWORD *pnBytesRead, DWORD *pnMinNumberOfBytesNeeded );
A handle to the event log to be read. The OpenEventLog function returns this handle.
Use the following flag values to indicate how to read the log file. This parameter must include one of the following values (the flags are mutually exclusive).
You must specify one of the following flags to indicate the direction for successive read operations (the flags are mutually exclusive).
The log is read in chronological order (oldest to newest).
||The log is read in reverse chronological order (newest to oldest).|
The record number of the log-entry at which the read operation should start. This parameter is ignored unless dwReadFlags includes the EVENTLOG_SEEK_READ flag.
An application-allocated buffer that will receive one or more EVENTLOGRECORD structures. This parameter cannot be NULL, even if the nNumberOfBytesToRead parameter is zero.
The maximum size of this buffer is 0x7ffff bytes.
The size of the lpBuffer buffer, in bytes. This function will read as many log entries as will fit in the buffer; the function will not return partial entries.
A pointer to a variable that receives the number of bytes read by the function.
A pointer to a variable that receives the required size of the lpBuffer buffer. This value is valid only this function returns zero and GetLastError returns ERROR_INSUFFICIENT_BUFFER.
If the function succeeds, the return value is nonzero.
If the function fails, the return value is zero. To get extended error information, call GetLastError.
When this function returns successfully, the read position in the event log is adjusted by the number of records read.
For an example, see Querying for Event Information.
|Minimum supported client||Windows 2000 Professional [desktop apps only]|
|Minimum supported server||Windows 2000 Server [desktop apps only]|
|Header||winbase.h (include Windows.h)|