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 [僅限傳統型應用程式] |
目標平臺 | 窗戶 |
標頭 | winbase.h (包括 Windows.h) |
連結庫 | Advapi32.lib |
DLL | Advapi32.dll |
API 集 | ext-ms-win-advapi32-eventlog-ansi-l1-1-0 (在 Windows 10 版本 10.0.10240 中引進) |