ClfsRemoveLogContainer function (wdm.h)

The ClfsRemoveLogContainer routine removes a container from a CLFS log.

Syntax

CLFSUSER_API NTSTATUS ClfsRemoveLogContainer(
  [in] PLOG_FILE_OBJECT plfoLog,
  [in] PUNICODE_STRING  puszContainerPath,
  [in] BOOLEAN          fForce
);

Parameters

[in] plfoLog

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

[in] puszContainerPath

A pointer to a UNICODE_STRING structure that supplies the path name for the container to be removed. The path name was created in a previous call to ClfsAddLogContainer or ClfsAddLogContainerSet. The path can be absolute or relative to the location of the base log file for the CLFS log that is 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

ClfsRemoveLogContainer 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 container to be removed is not part of the active log.

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

Requirements

See also

ClfsAddLogContainer

ClfsAddLogContainerSet

ClfsCreateLogFile

ClfsRemoveLogContainerSet

LOG_FILE_OBJECT

UNICODE_STRING