clfsScanLogContainers 函式 (wdm.h)
ClfsScanLogContainers 例程會擷取屬於特定 CLFS 記錄之容器序列的描述性資訊。
語法
CLFSUSER_API NTSTATUS ClfsScanLogContainers(
[in, out] PCLFS_SCAN_CONTEXT pcxScan,
[in] CLFS_SCAN_MODE eScanMode
);
參數
[in, out] pcxScan
CLFS_SCAN_CONTEXT 結構的指標。 呼叫端先前已配置結構,並藉由呼叫 ClfsCreateScanContext 加以初始化。 特別是, pInfoContainer 成員已初始化為指向 CLFS_CONTAINER_INFORMATION 結構的陣列, 而 cContainers 成員已初始化為數位中的元素數目。 傳回時,陣列中的結構會接收序列中容器的描述性資訊。
[in] eScanMode
一組旗標,指定掃描的方向,以及是否應該關閉掃描內容。 此例程的呼叫端可以使用下列旗標。
值 | 意義 |
---|---|
CLFS_SCAN_FORWARD | 正向掃描。 例如,如果容器 5 是最近掃描的容器, 而 pxcScan->cContainers 等於兩個,則此例程會傳回容器 6 和 7 的描述項。 |
CLFS_SCAN_BACKWARD | 以向後方向掃描。 例如,如果容器 5 是最近掃描的容器, 而 pxcScan->cContainers 等於兩個,則此例程會傳回容器 4 和 3 的描述項。 |
CLFS_SCAN_CLOSE | 釋放與 pcxScan所指向之掃描內容相關聯的所有資源。 |
如果已設定CLFS_SCAN_CLOSE旗標,則必須清除CLFS_SCAN_FORWARD和CLFS_SCAN_BACKWARD旗標。
如果CLFS_SCAN_CLOSE旗標清楚,則必須設定 (CLFS_SCAN_FORWARD 或CLFS_SCAN_BACKWARD) 其中一个方向旗标。
傳回值
ClfsScanLogContainers 會在成功時傳回STATUS_SUCCESS;否則,它會傳回 Ntstatus.h 中定義的其中一個錯誤碼。
備註
CLFS 會使用 CLFS_SCAN_CONTEXT 結構來追蹤容器掃描開始的位置, (cIndex 成員) ,以及每次呼叫 ClfsScanLogContainers 時掃描的容器數目。 cContainers 成員的值 N 會指定每次呼叫 ClfsScanLogContainers 時,都會掃描下一個 N 個容器。
CLFS_SCAN_CONTEXT 結構的 cContainersReturned 成員會接收在單一呼叫 ClfsScanLogContainers 中實際掃描的容器數目。
當 ClfsScanLogContainers 傳回STATUS_NO_MORE_ENTRIES時,不會再掃描任何容器。
當您完成使用 pcxScan所指向的掃描內容時,您必須呼叫 ClfsScanLogContainers,且 eScanMode 等於 CLFS_SCAN_CLOSE,以釋放與掃描內容相關聯的任何資源。
如需CLFS概念和術語的說明,請參閱 一般記錄檔系統。
規格需求
需求 | 值 |
---|---|
最低支援的用戶端 | 適用於 Windows Server 2003 R2、Windows Vista 和更新版本的 Windows。 |
目標平台 | 桌面 |
標頭 | wdm.h (包括 Wdm.h、Ntddk.h、Ntifs.h) |
程式庫 | Clfs.lib |
Dll | Clfs.sys |
IRQL | <= APC_LEVEL |