CLS_SCAN_CONTEXT structure (clfs.h)

Contains information about the containers that are being scanned by ScanLogContainers, the kind of scan that is being performed, and a cursor to track which containers have been scanned.

Syntax

typedef struct _CLS_SCAN_CONTEXT {
  CLFS_NODE_ID               cidNode;
  HANDLE                     hLog;
  ULONG                      cIndex;
  ULONG                      cContainers;
  ULONG                      cContainersReturned;
  CLFS_SCAN_MODE             eScanMode;
  PCLS_CONTAINER_INFORMATION pinfoContainer;
} CLS_SCAN_CONTEXT, *PCLS_SCAN_CONTEXT, PPCLS_SCAN_CONTEXT;

Members

cidNode

The ID of the current node. For more information, see CLFS_NODE_ID.

hLog

A handle to the log being scanned that is obtained from CreateLogFile with permissions to scan the log containers.

cIndex

The index of the current container.

cContainers

The number of system-allocated CLFS_CONTAINER_INFORMATION structures in an array that is pointed to by pinfoContainer.

That is, this member is the number of containers to scan with each scan call. The caller knows the scan is complete when the number of containers returned is less than this value.

cContainersReturned

The number of containers that are returned after a call to ScanLogContainers.

eScanMode

The mode in which containers are scanned.

Containers can be scanned in one of the following modes.

Value	Meaning
CLFS_SCAN_INIT	Initializes the scan context, but does not allocate associated storage. The initialization is destructive, because all data that is stored in the current scan context is lost.
CLFS_SCAN_CLOSE	Uninitializes the scan context and deallocates system storage that is associated with a scan context.
CLFS_SCAN_FORWARD	Causes the next call to ScanLogContainers to proceed in a forward direction. Cannot be used if CLFS_SCAN_BACKWARD is specified.
CLFS_SCAN_BACKWARD	Causes the next call to ScanLogContainers to proceed in a backward direction. Cannot be used if CLFS_SCAN_FORWARD is specified.

pinfoContainer

A pointer to a client-allocated array of CLFS_CONTAINER_INFORMATION structures to be filled by ScanLogContainers after each successful call.

Remarks

This structure is allocated by the client, initialized using CreateLogContainerScanContext, and then passed to ScanLogContainers in repeated calls.

Requirements

Requirement	Value
Minimum supported client	Windows 10 Build 20348
Minimum supported server	Windows 10 Build 20348
Header	clfs.h

See also

CLFS_CONTAINER_INFORMATION

CLFS_NODE_ID

ScanLogContainers