AdvanceLogBase function (clfsw32.h)

Article
02/22/2024

Advances the base log sequence number (LSN) of a log stream to the specified LSN.

Syntax

CLFSUSER_API BOOL AdvanceLogBase(
  [in, out]           PVOID        pvMarshal,
  [in]                PCLFS_LSN    plsnBase,
  [in]                ULONG        fFlags,
  [in, out, optional] LPOVERLAPPED pOverlapped
);

Parameters

[in, out] pvMarshal

A pointer to the marshaling context that a successful call to CreateLogMarshallingArea returns.

[in] plsnBase

The new base LSN for the log that is specified in pvMarshal.

This LSN must be in the range between the current base LSN and the last LSN of the log, inclusively.

[in] fFlags

This parameter is not implemented at this time, and must be zero.

[in, out, optional] pOverlapped

A pointer to an OVERLAPPED structure that is required for asynchronous operation.

If asynchronous operation is not used, this parameter can be NULL.

Return value

If the function succeeds, the return value is nonzero.

If the function fails, the return value is zero. To get extended error information, call GetLastError.

The following list identifies the possible error codes:

Remarks

AdvanceLogBase might flush data and metadata when it is called.

Requirements

Requirement	Value
Minimum supported client	Windows Vista [desktop apps only]
Minimum supported server	Windows Server 2003 R2 [desktop apps only]
Target Platform	Windows
Header	clfsw32.h
Library	Clfsw32.lib
DLL	Clfsw32.dll