The ClearEventLog function clears the specified event log, and optionally saves the current copy of the logfile to a backup file.
BOOL ClearEventLog(
HANDLE hEventLog, |
// handle to event log |
LPCTSTR lpBackupFileName |
// name of backup file |
); |
The backup filename may contain a server name to save the backup file on a remote server.
If the lpBackupFileName parameter is NULL, the current event logfile is not backed up.
If the function succeeds, the return value is nonzero. The specified event log has been backed up (if lpBackupFileName is not NULL) and then cleared.
If the function fails, the return value is zero. To get extended error information, call GetLastError.
The ClearEventLog function fails if the event log is empty.
After this function returns, any handles that reference the cleared event log cannot be used to read the log.
If the backup filename specifies a remote server, the event log handle must identify a log on the local computer. You cannot back up an event logfile from a remote server to a file on a remote server (even if the backup file and the original log are on the same server).
The ClearEventLog function is used to optionally back up an existing logfile of the module represented by hEventLog. The function backs up the logfile to another file, and then clears the existing logfile. The caller must have write permission for the path specified, and must also have permission to move the current logfile. If a file already exists with the same name as lpBackupFileName, ClearEventLog fails.
file: /Techref/os/win/api/win32/func/src/f05_15.htm, 3KB, , updated: 2000/4/7 11:19, local time: 2024/11/5 04:15,
3.231.219.178:LOG IN ©2024 PLEASE DON'T RIP! THIS SITE CLOSES OCT 28, 2024 SO LONG AND THANKS FOR ALL THE FISH!
|
©2024 These pages are served without commercial sponsorship. (No popup ads, etc...).Bandwidth abuse increases hosting cost forcing sponsorship or shutdown. This server aggressively defends against automated copying for any reason including offline viewing, duplication, etc... Please respect this requirement and DO NOT RIP THIS SITE. Questions? <A HREF="http://www.piclist.com/techref/os/win/api/win32/func/src/f05_15.htm"> ClearEventLog</A> |
Did you find what you needed? |
PICList 2024 contributors:
o List host: MIT, Site host massmind.org, Top posters @none found - Page Editors: James Newton, David Cary, and YOU! * Roman Black of Black Robotics donates from sales of Linistep stepper controller kits. * Ashley Roll of Digital Nemesis donates from sales of RCL-1 RS232 to TTL converters. * Monthly Subscribers: Gregg Rew. on-going support is MOST appreciated! * Contributors: Richard Seriani, Sr. |
Welcome to www.piclist.com! |
.