RemoveLogContainer 函式 (clfsw32.h)
從與專用或多任務處理記錄句柄相關聯的記錄中移除一個容器。
客戶端必須具有記錄句柄的系統管理許可權,才能移除容器。 若要移除多個容器,請使用 RemoveLogContainerSet 函式。
語法
CLFSUSER_API BOOL RemoveLogContainer(
[in] HANDLE hLog,
[in] LPWSTR pwszContainerPath,
[in] BOOL fForce,
[in, out, optional] LPVOID pReserved
);
參數
[in] hLog
從 CreateLogFile 取得之記錄檔的句柄。
[in] pwszContainerPath
寬字元字串的指標,其中包含 AddLogContainer 或 AddLogContainerSet 所建立之記錄容器的路徑。
[in] fForce
決定何時和如何刪除容器的刪除旗標。
如果 fForce 為 TRUE,且容器是使用中記錄區域的一部分,則不會刪除容器,並傳回 錯誤ERROR_LOG_CANT_DELETE 。
如果 為 FALSE,當容器不再是使用中記錄區域的一部分時,就會刪除容器。
[in, out, optional] pReserved
此參數是保留的,應該設定為 NULL。
傳回值
如果函式成功,則傳回非零的值。
如果此函式失敗,則傳回值為零。 若要取得擴充的錯誤資訊,請呼叫 GetLastError。
下列清單會識別可能的錯誤碼:
備註
根據預設,容器刪除是延遲的,這表示只有在容器不是使用中記錄檔的一部分時,才會刪除容器。 如果容器是使用中記錄檔的一部分,則會將其標示為要刪除。 不過,刪除不會發生,直到記錄結尾超過容器的最後一個扇區,或容器的邏輯標識元大於使用中記錄檔前端的邏輯標識符為止。 只有在實際刪除容器時,記錄大小才會反映容器刪除。
記錄用戶端可以將刪除旗標設定為 TRUE,以要求在容器上強制刪除。 這與刪除不屬於使用中記錄檔一部分的容器相同。 不過,如果容器是使用中記錄檔的一部分,呼叫就會失敗,而不會標記容器進行刪除。
規格需求
需求 | 值 |
---|---|
最低支援的用戶端 | Windows Vista [僅限傳統型應用程式] |
最低支援的伺服器 | Windows Server 2003 R2 [僅限傳統型應用程式] |
目標平台 | Windows |
標頭 | clfsw32.h |
程式庫 | Clfsw32.lib |
Dll | Clfsw32.dll |