Функция ClearEventLogW (winbase.h)
Очищает указанный журнал событий и при необходимости сохраняет текущую копию журнала в файл резервной копии.
Синтаксис
BOOL ClearEventLogW(
[in] HANDLE hEventLog,
[in] LPCWSTR lpBackupFileName
);
Параметры
[in] hEventLog
Дескриптор для очищаемого журнала событий. Функция OpenEventLog возвращает этот дескриптор.
[in] lpBackupFileName
Абсолютный или относительный путь к файлу резервной копии. Если этот файл уже существует, функция завершается ошибкой.
Если параметр lpBackupFileName имеет значение NULL, резервное копирование журнала событий не создается.
Возвращаемое значение
Если функция выполняется успешно, возвращается ненулевое значение.
Если функция выполняется неудачно, возвращается нулевое значение. Дополнительные сведения об ошибке можно получить, вызвав GetLastError. Функция ClearEventLog может завершиться ошибкой, если журнал событий пуст или файл резервной копии уже существует.
Комментарии
После возврата этой функции все дескрипторы, ссылающиеся на очищенный журнал событий, нельзя использовать для чтения журнала.
Примечание
Заголовок winbase.h определяет ClearEventLog в качестве псевдонима, который автоматически выбирает версию ANSI или Юникод этой функции на основе определения константы препроцессора ЮНИКОД. Использование псевдонима, не зависящий от кодирования, с кодом, который не является нейтральным для кодировки, может привести к несоответствиям, которые приводят к ошибкам компиляции или времени выполнения. Дополнительные сведения см. в разделе Соглашения для прототипов функций.
Требования
| Требование | Значение |
|---|---|
| Минимальная версия клиента | Windows 2000 Professional [только классические приложения] |
| Минимальная версия сервера | Windows 2000 Server [только классические приложения] |
| Целевая платформа | Windows |
| Header | winbase.h (включая Windows.h) |
| Библиотека | Advapi32.lib |
| DLL | Advapi32.dll |
| Набор API | ext-ms-win-advapi32-eventlog-ansi-l1-1-0 (представлено в Windows 10 версии 10.0.10240) |