ClearEventLog功能可清除指定的事件日志,并可选择将日志文件的当前副本保存到备份文件。
BOOL ClearEventLog(
HANDLE 【hEventLog】, | //处理事件日志 |
LPCTSTR 【lpBackupFileName】 | //备份文件的名称 |
); |
参数
【hEventLog】
标识要清除的事件日志。该句柄由OpenEventLog函数返回。
【lpBackupFileName】
指向以null结尾的字符串,指定将放置事件日志文件的当前副本的文件的名称。如果此文件已存在,则该函数将失败。
备份文件名可能包含将备份文件保存在远程服务器上的服务器名称。
如果【lpBackupFileName】参数为NULL,则不备份当前事件日志文件。
返回值
如果函数成功,返回值不为零。已备份指定的事件日志(如果【lpBackupFileName】不为NULL),然后清除。
如果函数失败,返回值为零。要获取扩展错误信息,请调用GetLastError.
备注
如果事件日志为空,则ClearEventLog功能将失败。
此函数返回后,引用清除事件日志的任何句柄都不能用于读取日志。
如果备份文件名指定远程服务器,则事件日志句柄必须在本地计算机上标识日志。您不能将事件日志文件从远程服务器备份到远程服务器上的文件(即使备份文件和原始日志位于同一服务器上)。
ClearEventLog功能用于可选地备份由【hEventLog】表示的模块的现有日志文件。该函数将日志文件备份到另一个文件,然后清除现有的日志文件。调用者必须具有指定路径的写入权限,并且还必须具有移动当前日志文件的权限。如果文件已经存在与【lpBackupFileName】同名,ClearEventLog将失败。
也可以看看