Функция ClearEventLogA (winbase.h)

Статья
11/20/2024

Очищает указанный журнал событий и при необходимости сохраняет текущую копию журнала в файл резервной копии.

Синтаксис

BOOL ClearEventLogA(
  [in] HANDLE hEventLog,
  [in] LPCSTR lpBackupFileName
);

Параметры

[in] hEventLog

Дескриптор для очистки журнала событий. Функция OpenEventLog возвращает этот дескриптор.

[in] lpBackupFileName

Абсолютный или относительный путь к файлу резервной копии. Если этот файл уже существует, функция завершается ошибкой.

Если параметр lpBackupFileNameNULL, журнал событий не резервируется.

Возвращаемое значение

Если функция выполнена успешно, возвращаемое значение ненулевое.

Если функция завершается ошибкой, возвращаемое значение равно нулю. Чтобы получить расширенные сведения об ошибке, вызовите GetLastError. Функция ClearEventLog может завершиться ошибкой, если журнал событий пуст или файл резервной копии уже существует.

Замечания

После возврата этой функции все дескрипторы, ссылающиеся на очищаемый журнал событий, нельзя использовать для чтения журнала.

Заметка

Заголовок winbase.h определяет ClearEventLog как псевдоним, который автоматически выбирает версию 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)

См. также

Функции ведения журнала событий

OpenEventLog

Поделиться через