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) |
程式庫 | Advapi32.lib |
Dll | Advapi32.dll |
API 集合 | ext-ms-win-advapi32-eventlog-ansi-l1-1-0 (Windows 10 10.0.10240 版) |