clfsDeleteLogFile 函式 (wdm.h)

ClfsDeleteLogFile 例程會標示要刪除的CLFS資料流。

語法

CLFSUSER_API NTSTATUS ClfsDeleteLogFile(
  [in]           PUNICODE_STRING puszLogFileName,
                 PVOID           pvReserved,
  [in]           ULONG           fLogOptionFlag,
  [in, optional] PVOID           pvContext,
  [in]           ULONG           cbContext
);

參數

[in] puszLogFileName

UNICODE_STRING 結構的指標,提供要刪除之 CLFS 數據流的名稱。

如果要刪除的數據流是唯一專用記錄檔的數據流,則名稱的格式為log:physical log 名稱,其中 實體記錄檔名稱 是基礎文件系統上實體記錄檔的路徑名稱。

如果要刪除的數據流是多任務記錄檔的其中一個數據流,則名稱的格式為log:physical log name::stream 名稱,其中 實體記錄檔名稱 是基礎文件系統上實體記錄檔的路徑名稱,而 數據流名稱 是要刪除之數據流的唯一名稱。

pvReserved

保留的。

[in] fLogOptionFlag

值,表示CLFS與正在刪除記錄的元件之間的關聯性。 如需可能值的清單,請參閱 ClfsCreateLogFile 例程的 fLogOptionFlag 參數描述。

[in, optional] pvContext

內容的指標。 內容解譯的方式取決於 在 fLogOptionFlag 中傳遞的值。

[in] cbContext

pvContext 所指向內容的大小,以位元組為單位。 如果 pvContext 不是 NULL,此參數必須大於零。

傳回值

ClfsDeleteLogFile 會在成功時傳回STATUS_SUCCESS;否則,它會傳回 Ntstatus.h 中定義的其中一個錯誤碼。

備註

COMMON Log File System (CLFS) 會使用 LOG_FILE_OBJECT 結構來表示記錄。 ClfsCreateLogFile 函式會傳回指向LOG_FILE_OBJECT的指標,然後用戶端會傳遞至其他 CLFS 函式。

CLFS 用戶端不會直接存取LOG_FILE_OBJECT結構的成員。 如需成員的相關信息,請參閱 FILE_OBJECT

ClfsDeleteLogFile 會標示要刪除的數據流,但不會關閉目前開啟的任何記錄檔物件。 若要關閉記錄檔物件,請呼叫 ClfsCloseLogFileObject。 在關閉與數據流相關聯的所有記錄檔對象之後,就會刪除標示要刪除的數據流。

標示要刪除的 CLFS 數據流將會拒絕後續要求來開啟數據流。

實體 CLFS 記錄檔的名稱不包含 .blf 擴展名。

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

規格需求

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

另請參閱

ClfsCloseAndResetLogFile

ClfsCloseLogFileObject

ClfsCreateLogFile

ClfsDeleteLogByPointer