DeleteLogFile 函式 (clfsw32.h)
標記要刪除的記錄。 當記錄檔的所有句柄、封送處理區域和讀取內容關閉時,實際上會刪除記錄檔。 如果記錄檔是實體記錄檔,則會刪除其基礎容器。
當記錄標示為要刪除時,開啟新用戶端記錄數據流的要求會失敗。
附註DeleteLogByHandle,這會在指定檔案句柄時刪除記錄檔。
語法
CLFSUSER_API BOOL DeleteLogFile(
[in] LPCWSTR pszLogFileName,
[in, optional] PVOID pvReserved
);
參數
[in] pszLogFileName
記錄檔的名稱。
使用 createLogFile 建立記錄檔時,會指定這個名稱。 下列範例會識別要使用的格式:
記錄檔:<記錄檔名稱>[::<記錄數據流名稱>]
< 記錄檔名稱> 對應至文件系統中的有效檔案路徑。
< 記錄數據流名稱> 是記錄檔中記錄數據流的唯一名稱。
如需詳細資訊,請參閱 記錄類型。
[in, optional] pvReserved
這個參數是保留的,而且應該設定為 NULL。
傳回值
如果函式成功,則傳回值為非零值。
如果函式失敗,傳回值為零 (0)。 若要取得擴充的錯誤資訊,請呼叫 GetLastError。 下列清單會識別可能的錯誤碼:
要求
要求 | 價值 |
---|---|
最低支援的用戶端 | Windows Vista [僅限傳統型應用程式] |
支援的最低伺服器 | Windows Server 2003 R2 [僅限傳統型應用程式] |
目標平臺 | 窗戶 |
標頭 | clfsw32.h |
連結庫 | Clfsw32.lib |
DLL | Clfsw32.dll |