ClfsSetArchiveTail function (wdm.h)

The ClfsSetArchiveTail routine sets the archive tail of a CLFS log to a specified LSN.

Syntax

CLFSUSER_API NTSTATUS ClfsSetArchiveTail(
  [in] PLOG_FILE_OBJECT plfoLog,
  [in] PCLFS_LSN        plsnArchiveTail
);

Parameters

[in] plfoLog

A pointer to a LOG_FILE_OBJECT structure that represents a CLFS log. The caller previously obtained this pointer by calling ClfsCreateLogFile.

[in] plsnArchiveTail

A pointer to a CLFS_LSN structure that specifies the LSN that is to become the new archive tail. This must be the exact LSN of a record in the log.

Return value

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

Remarks

The plsnArchiveTail value specifies where archiving starts in the log. The next archiving will start at or before this LSN.

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

See also

ClfsAdvanceLogBase

ClfsCreateLogFile

ClfsSetEndOfLog

LOG_FILE_OBJECT