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