clfsCreateScanContext 函式 (wdm.h)
ClfsCreateScanContext 例程會建立掃描內容,可用來逐一查看指定 CLFS 記錄的容器。
語法
CLFSUSER_API NTSTATUS ClfsCreateScanContext(
[in] PLOG_FILE_OBJECT plfoLog,
[in] ULONG cFromContainer,
[in] ULONG cContainers,
[in] CLFS_SCAN_MODE eScanMode,
[in, out] PCLFS_SCAN_CONTEXT pcxScan
);
參數
[in] plfoLog
表示 CLFS 數據流 之LOG_FILE_OBJECT 結構的指標。 系統會針對提供該數據流基礎記憶體的記錄檔建立掃描內容。 呼叫端先前藉由呼叫 ClfsCreateLogFile 來取得此指標。
[in] cFromContainer
要掃描之第一個容器的索引。 容器的索引從零開始。
[in] cContainers
每個 呼叫 ClfsScanLogContainers 時要掃描的容器數目。
[in] eScanMode
一組旗標,指定掃描內容是否設定為向前或向後掃描,以及是否應該重新初始化掃描內容。 下列三個旗標可供此例程的呼叫端使用。
值 | 意義 |
---|---|
CLFS_SCAN_FORWARD | 設定掃描內容,以向前方向掃描。 例如,如果容器 5 是最近掃描的容器, 而 cContainers 是 2,則向前掃描會傳回容器 6 和 7 的描述元。 |
CLFS_SCAN_BACKWARD | 設定掃描內容,以向後掃描。 例如,如果容器 5 是最近掃描的容器, 而 cContainers 是 2,則回溯掃描會傳回容器 4 和 3 的描述項。 |
CLFS_SCAN_INIT | 重新初始化掃描內容。 下次呼叫 ClfsScanLogContainers 時,它的行為會如同在建立掃描內容之後第一次呼叫它一樣。 |
如果 pcxScan 指向第一次傳遞至此例程的CLFS_SCAN_CONTEXT結構,則必須設定其中一個方向旗標 (CLFS_SCAN_FORWARD 或CLFS_SCAN_BACKWARD) 。 CLFS_SCAN_INIT旗標不得設定。
如果 pcxScan 指向先前傳遞至此例程的CLFS_SCAN_CONTEXT結構,則必須設定CLFS_SCAN_INIT旗標。 此外,必須設定 (CLFS_SCAN_FORWARD 或CLFS_SCAN_BACKWARD) 的其中一个方向旗标和其中一个方向旗标。
[in, out] pcxScan
呼叫端配置的 CLFS_SCAN_CONTEXT 結構的指標,其成員是由這個例程初始化。 此結構稍後會傳遞至 ClfsScanLogContainers。
傳回值
ClfsCreateScanContext 會在成功時傳回STATUS_SUCCESS;否則,它會傳回 Ntstatus.h 中的其中一個錯誤碼。
備註
如需CLFS概念和術語的說明,請參閱 一般記錄檔系統。
規格需求
需求 | 值 |
---|---|
最低支援的用戶端 | 可在 Windows Server 2003 R2、Windows Vista 和更新版本的 Windows 中使用。 |
目標平台 | 桌面 |
標頭 | wdm.h (包含 Wdm.h) |
程式庫 | Clfs.lib |
Dll | Clfs.sys |
IRQL | <= APC_LEVEL |