ClfsSetEndOfLog function (wdm.h)

The ClfsSetEndOfLog routine truncates a CLFS stream.

Syntax

CLFSUSER_API NTSTATUS ClfsSetEndOfLog(
  [in] PLOG_FILE_OBJECT plfoLog,
  [in] PCLFS_LSN        plsnEnd
);

Parameters

[in] plfoLog

A pointer to a LOG_FILE_OBJECT structure that represents a CLFS stream. This stream must be the only stream of a dedicated log. The caller previously obtained this pointer by calling ClfsCreateLogFile.

[in] plsnEnd

A pointer to a CLFS_LSN structure that supplies the LSN of the record that is to become the last record of the stream. This must be the exact LSN of one of the records in the stream.

Return value

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

Remarks

The LSN supplied in the plsnEnd value is not validated. It is the responsibility of the caller to provide a valid LSN; that is, one that is the exact LSN of a record in the stream.

This stream represented by plfoLog must be from a dedicated log. This routine does not support streams from multiplexed logs.

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

The kernel-mode routine ClfsSetEndOfLog is reserved for future use and currently always returns STATUS_NOT_SUPPORTED. However, the user-mode routine SetEndOfLog is currently supported.

Requirements

See also

CLFS_LSN

ClfsAdvanceLogBase

ClfsCreateLogFile

ClfsSetArchiveTail

ClfsSetEndOfLog

LOG_FILE_OBJECT