ScanLogContainers 函数 (clfsw32.h)

项目
08/22/2023

枚举日志容器。重复调用此函数以循环访问所有日志容器。

语法

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。

以下列表标识了可能的错误代码：

注解

日志容器的 ID 在 pcxScan-pinfoContainer-LogicalContainerId>> 中返回。

注意通用日志文件系统 (CLFS) 扫描上下文不是线程安全的。它们不应一次由多个线程使用，也不能一次传递到多个异步扫描中。

示例

有关使用此函数的示例，请参阅枚举日志容器。

要求

要求	值
最低受支持的客户端	Windows Vista [仅限桌面应用]
最低受支持的服务器	Windows Server 2003 R2 [仅限桌面应用]
目标平台	Windows
标头	clfsw32.h
Library	Clfsw32.lib
DLL	Clfsw32.dll