ClearEventLogA 函数 (winbase.h)

清除指定的事件日志，并选择性地将日志的当前副本保存到备份文件。

语法

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

[in] hEventLog

要清除的事件日志的句柄。 OpenEventLog 函数返回此句柄。

[in] lpBackupFileName

备份文件的绝对路径或相对路径。如果此文件已存在，则函数将失败。

如果 lpBackupFileName 参数为 NULL，则不备份事件日志。

如果该函数成功，则返回值为非零值。

如果函数失败，则返回值为零。要获得更多的错误信息，请调用 GetLastError。如果事件日志为空或备份文件已存在， ClearEventLog 函数可能会失败。

此函数返回后，任何引用清除事件日志的句柄都不能用于读取日志。

注意

winbase.h 标头将 ClearEventLog 定义为别名，该别名根据 UNICODE 预处理器常量的定义自动选择此函数的 ANSI 或 Unicode 版本。将非特定编码别名的使用与非非特定编码的代码混合使用可能会导致不匹配，从而导致编译或运行时错误。有关详细信息，请参阅函数原型的约定。


最低受支持的客户端	Windows 2000 Professional [仅限桌面应用]
最低受支持的服务器	Windows 2000 Server [仅限桌面应用]
目标平台	Windows
标头	winbase.h (包括 Windows.h)
Library	Advapi32.lib
DLL	Advapi32.dll
API 集	Windows 10版本 10.0.10240 中引入的 ext-ms-win-advapi32-eventlog-ansi-l1-1-0 ()