ClfsRemoveLogContainerSet function (wdm.h)

Article
02/22/2024

The ClfsRemoveLogContainerSet routine atomically removes a set of containers from a CLFS log.

Syntax

CLFSUSER_API NTSTATUS ClfsRemoveLogContainerSet(
  [in] PLOG_FILE_OBJECT plfoLog,
  [in] USHORT           cContainers,
  [in] PUNICODE_STRING  rgwszContainerPath,
  [in] BOOLEAN          fForce
);

Parameters

[in] plfoLog

A pointer to a LOG_FILE_OBJECT structure that represents the CLFS log from which the containers will be removed. The caller previously obtained this pointer by calling ClfsCreateLogFile.

[in] cContainers

The number of containers in the set. This is the number of elements in the rgwszContainerPath array.

[in] rgwszContainerPath

A pointer to an array of UNICODE_STRING structures, each of which supplies the path name for one of the containers to be removed. The number of elements in the array is given by cContainers. A given path can be absolute or relative to the location of the base log file for the CLFS log represented by plfoLog. Paths that are relative to the base log file must begin with CLFS_CONTAINER_RELATIVE_PREFIX, which is the string literal (L"%BLF%\"). The directories "." and ".." are not allowed in a relative path.

[in] fForce

A Boolean value that specifies whether the container removal is forced (TRUE) or lazy (FALSE).

Return value

ClfsRemoveLogContainerSet returns STATUS_SUCCESS if it succeeds; otherwise, it returns one of the error codes defined in Ntstatus.h.

Remarks

Forced container removal (fForce = TRUE) succeeds only if the containers to be removed are not part of the active log.

For an explanation of CLFS concepts and terminology, see Common Log File System.

Requirements

Requirement	Value
Minimum supported client	Available in Windows Server 2003 R2, Windows Vista, and later versions of Windows.
Target Platform	Desktop
Header	wdm.h (include Wdm.h)
Library	Clfs.lib
DLL	Clfs.sys
IRQL	<= APC_LEVEL