EvtClearLog 函式 (winevt.h)
從指定的通道移除所有事件,並將其寫入目標記錄檔。
語法
BOOL EvtClearLog(
[in, optional] EVT_HANDLE Session,
[in] LPCWSTR ChannelPath,
[in, optional] LPCWSTR TargetFilePath,
[in] DWORD Flags
);
參數
[in, optional] Session
EvtOpenSession 函式傳回的遠端會話句柄。 設定為 本機 通道的NULL。
[in] ChannelPath
要清除的通道名稱。
[in, optional] TargetFilePath
將接收事件的目標記錄檔完整路徑。 設定為 NULL 以清除記錄檔,而不會儲存事件。
[in] Flags
保留的。 必須為零。
傳回值
傳回碼/值 | Description |
---|---|
|
此函數已成功。 |
|
函式失敗。 使用 GetLastError 函式來取得錯誤碼。 |
備註
若要從通道或記錄檔複製事件,請呼叫 EvtExportLog 函式。
您必須指定目標記錄檔的絕對路徑;您無法使用相對路徑和環境變數來指定目標記錄檔。 路徑可以是 UNC) 路徑 (通用命名慣例。 您應該使用 .evtx 作為擴展名。
此函式只會影響通道—如果通道使用 autoBackup 或 fileMax,此函式不會影響這些備份檔。
規格需求
需求 | 值 |
---|---|
最低支援的用戶端 | Windows Vista [僅限傳統型應用程式] |
最低支援的伺服器 | Windows Server 2008 [僅限傳統型應用程式] |
目標平台 | Windows |
標頭 | winevt.h |
程式庫 | Wevtapi.lib |
Dll | Wevtapi.dll |