ClfsRemoveLogContainer 函式 (wdm.h)

發行項
03/01/2024

ClfsRemoveLogContainer 例程會從CLFS記錄中移除容器。

語法

CLFSUSER_API NTSTATUS ClfsRemoveLogContainer(
  [in] PLOG_FILE_OBJECT plfoLog,
  [in] PUNICODE_STRING  puszContainerPath,
  [in] BOOLEAN          fForce
);

參數

[in] plfoLog

LOG_FILE_OBJECT 結構的指標，表示要從中移除容器的CLFS記錄檔。呼叫端先前藉由呼叫 ClfsCreateLogFile 來取得此指標。

[in] puszContainerPath

UNICODE_STRING 結構的指標，提供要移除之容器的路徑名稱。路徑名稱是在先前呼叫 ClfsAddLogContainer 或 ClfsAddLogContainerSet 中建立。路徑可以是絕對或相對於 plfoLog 所代表之 CLFS 記錄檔的基底記錄檔位置。相對於基底記錄檔的路徑必須以CLFS_CONTAINER_RELATIVE_PREFIX開頭，也就是字串常值 (L“%BLF%\”) 。相對路徑中不允許目錄「.」和「.」。

[in] fForce

布爾值，指定是否強制移除容器 (TRUE) 或延遲 (FALSE) 。

傳回值

ClfsRemoveLogContainer 如果成功，則會傳回STATUS_SUCCESS;否則，它會傳回 Ntstatus.h 中定義的其中一個錯誤碼。

備註

只有在要移除的容器不是使用中記錄檔的一部分時，強制容器移除 (fForce = TRUE) 才會成功。

如需CLFS概念和術語的說明，請參閱一般記錄檔系統。

規格需求

需求	值
最低支援的用戶端	可在 Windows Server 2003 R2、Windows Vista 和更新版本的 Windows 中使用。
目標平台	桌面
標頭	wdm.h (包含 Wdm.h)
程式庫	Clfs.lib
Dll	Clfs.sys
IRQL	<= APC_LEVEL