Edit

Share via

CLS_CONTAINER_INFORMATION structure (clfs.h)

  • Article

Describes general information about a container. The CreateLogContainerScanContext and ScanLogContainers functions use container descriptors to scan and return information about all Common Log File System (CLFS) containers.

Syntax

typedef struct _CLS_CONTAINER_INFORMATION {
  ULONG                FileAttributes;
  ULONGLONG            CreationTime;
  ULONGLONG            LastAccessTime;
  ULONGLONG            LastWriteTime;
  LONGLONG             ContainerSize;
  ULONG                FileNameActualLength;
  ULONG                FileNameLength;
  WCHAR                FileName[CLFS_MAX_CONTAINER_INFO];
  CLFS_CONTAINER_STATE State;
  CLFS_CONTAINER_ID    PhysicalContainerId;
  CLFS_CONTAINER_ID    LogicalContainerId;
} CLS_CONTAINER_INFORMATION, *PCLS_CONTAINER_INFORMATION, PPCLS_CONTAINER_INFORMATION;

Members

FileAttributes

The file system attributes. CLFS uses the following attributes:

  • FILE_ATTRIBUTE_ARCHIVE - The log is not ephemeral.
  • FILE_ATTRIBUTE_DEDICATED - The log is not multiplexed.
  • FILE_ATTRIBUTE_READONLY - The file is read-only. Applications can read the file, but cannot write to it or delete it.
CLFS ignores but preserves all other file attribute values. The SetFileAttributes topic lists the valid values for attributes.

CreationTime

The time a file is created.

LastAccessTime

The last time a container is read from or written to.

LastWriteTime

The last time a container is written to.

ContainerSize

The size of a container, in bytes.

FileNameActualLength

The size of the actual file name, in characters.

This number is different than FileNameLength when the file name of the container is longer than MAX_PATH_LENGTH.

FileNameLength

The size of the file name in the FileName buffer, in characters.

FileName[CLFS_MAX_CONTAINER_INFO]

A pointer to a string that contains the file name for a container.

State

The current state of a container.

This member can be one of the following values.

Value Meaning
ClfsContainerInitializing
 The container is in the process of initializing.
ClfsContainerInactive
 The container is allocated, but is not in the active region of the log.
ClfsContainerActive
 The container is being used as storage for part of the log.
ClfsContainerActivePendingDelete
 The container is marked for deletion, but still contains part of the active log.
ClfsContainerPendingArchive
 The container is marked for archive.
ClfsContainerPendingArchiveAndDelete
 The container is marked for deletion, but still contains log data that is not archived.

PhysicalContainerId

The physical container identifier that cannot be changed.

LogicalContainerId

The logical container identifier that changes every time the container is recycled.

Requirements

Requirement Value
Minimum supported client Windows Vista [desktop apps only]
Minimum supported server Windows Server 2003 R2 [desktop apps only]
Header clfs.h (include Clfsw32.h)

See also

CreateLogContainerScanContext

GetLogContainerName

ScanLogContainers