ScanLogContainers 函式 (clfsw32.h)

發行項
02/28/2024

列舉記錄容器。重複呼叫此函式，以逐一查看所有記錄容器。

語法

CLFSUSER_API BOOL ScanLogContainers(
  [in, out]           PCLFS_SCAN_CONTEXT pcxScan,
  [in]                CLFS_SCAN_MODE     eScanMode,
  [in, out, optional] LPVOID             pReserved
);

參數

[in, out] pcxScan

CreateLogContainerScanContext 函式初始化的用戶端配置CLFS_SCAN_CONTEXT結構的指標。

[in] eScanMode

要掃描之容器的模式。

您可以在下列任何一種CLFS_SCAN_MODE 模式中掃描容器。

值	意義
CLFS_SCAN_INIT	重新初始化掃描內容，但不會配置相關聯的記憶體。初始化是破壞性的，因為儲存在目前掃描內容中的所有數據都會遺失。
CLFS_SCAN_CLOSE	取消初始化掃描內容，並解除分配與掃描內容相關聯的系統記憶體。
CLFS_SCAN_FORWARD	導致下一次呼叫 ScanLogContainers 以向前方向繼續。如果指定 CLFS_SCAN_BACKWARD ，則無法使用。
CLFS_SCAN_BACKWARD	導致下一次呼叫 ScanLogContainers 以向後方向繼續。如果指定 CLFS_SCAN_FORWARD，則無法使用。

[in, out, optional] pReserved

保留的。將 pReserved 設定為 NULL。

傳回值

如果函式成功，則傳回非零的值。

如果此函式失敗，則傳回值為零。若要取得擴充的錯誤資訊，請呼叫 GetLastError。

下列清單會識別可能的錯誤碼：

備註

記錄容器的標識碼會傳回：pcxScan-pinfoContainer-LogicalContainerId>>。

注意一般記錄檔系統 (CLFS) 掃描內容不是安全線程。一次不應由多個線程使用，或一次傳遞至多個異步掃描。

範例

如需使用此函式的範例，請參閱列舉記錄容器。

規格需求

需求	值
最低支援的用戶端	Windows Vista [僅限傳統型應用程式]
最低支援的伺服器	Windows Server 2003 R2 [僅限傳統型應用程式]
目標平台	Windows
標頭	clfsw32.h
程式庫	Clfsw32.lib
Dll	Clfsw32.dll