Функция ReadEventLogW (winbase.h)
Считывает указанное количество записей из указанного журнала событий. Функцию можно использовать для чтения записей журнала в хронологическом или обратном хронологическом порядке.
Синтаксис
BOOL ReadEventLogW(
[in] HANDLE hEventLog,
[in] DWORD dwReadFlags,
[in] DWORD dwRecordOffset,
[out] LPVOID lpBuffer,
[in] DWORD nNumberOfBytesToRead,
[out] DWORD *pnBytesRead,
[out] DWORD *pnMinNumberOfBytesNeeded
);
Параметры
[in] hEventLog
Дескриптор для чтения журнала событий. Функция OpenEventLog возвращает этот дескриптор.
[in] dwReadFlags
Используйте следующие значения флагов, чтобы указать, как считывать файл журнала. Этот параметр должен включать одно из следующих значений (флаги являются взаимоисключающими).
Необходимо указать один из следующих флагов, чтобы указать направление для последовательных операций чтения (флаги являются взаимоисключающими).
[in] dwRecordOffset
Число записей записи журнала, с которой должна начинаться операция чтения. Этот параметр игнорируется, если dwReadFlags включает флаг EVENTLOG_SEEK_READ.
[out] lpBuffer
Выделенный приложением буфер, который получит одну или несколько структур EVENTLOGRECOR D. Этот параметр не может быть значение NULL, даже если параметр nNumberOfBytesToRead равен нулю.
Максимальный размер этого буфера составляет 0x7ffff байт.
[in] nNumberOfBytesToRead
Размер буфера lpBuffer в байтах. Эта функция будет считывать столько записей журнала, сколько будет соответствовать буферу; Функция не вернет частичные записи.
[out] pnBytesRead
Указатель на переменную, которая получает количество байтов, считываемых функцией.
[out] pnMinNumberOfBytesNeeded
Указатель на переменную, которая получает требуемый размер буфера
Возвращаемое значение
Если функция выполнена успешно, возвращаемое значение ненулевое.
Если функция завершается ошибкой, возвращаемое значение равно нулю. Чтобы получить расширенные сведения об ошибке, вызовите GetLastError.
Замечания
Когда эта функция возвращается успешно, позиция чтения в журнале событий корректируется по количеству записей, считываемых.
Примеры
Пример см. в разделе запросы сведений о событиях.
Заметка
Заголовок winbase.h определяет ReadEventLog как псевдоним, который автоматически выбирает версию ANSI или Юникод этой функции на основе определения константы препроцессора ЮНИКОДа. Сочетание использования псевдонима, нейтрального для кодирования, с кодом, не зависящим от кодирования, может привести к несоответствиям, которые приводят к ошибкам компиляции или среды выполнения. Дополнительные сведения см. в соглашениях о прототипах функций.
Требования
Требование | Ценность |
---|---|
минимальные поддерживаемые клиентские | Windows 2000 Профессиональный [только классические приложения] |
минимальный поддерживаемый сервер | Windows 2000 Server [только классические приложения] |
целевая платформа | Виндоус |
заголовка | winbase.h (включая Windows.h) |
библиотеки |
Advapi32.lib |
DLL | Advapi32.dll |
набор API | ext-ms-win-advapi32-eventlog-ansi-l1-1-0 (представлено в Windows 10 версии 10.0.10240) |
См. также
Функции ведения журнала событий