Clears the specified event log, and optionally saves the current copy of the log to a backup file.

Syntax

BOOL ClearEventLog(
  __in  HANDLE hEventLog,
  __in  LPCTSTR lpBackupFileName
);

Parameters

hEventLog [in]

A handle to the event log to be cleared. The OpenEventLog function returns this handle.

lpBackupFileName [in]

The absolute or relative path of the backup file. If this file already exists, the function fails.

If the lpBackupFileName parameter is NULL, the event log is not backed up.

Return Value

If the function succeeds, the return value is nonzero.

If the function fails, the return value is zero. To get extended error information, call GetLastError. The ClearEventLog function can fail if the event log is empty or the backup file already exists.

Remarks

After this function returns, any handles that reference the cleared event log cannot be used to read the log.

Requirements

See Also

Event Logging Functions

OpenEventLog

Send comments about this topic to Microsoft

Build date: 11/12/2009