SetLogArchiveTail function (clfsw32.h)

Article
02/22/2024

Sets the last archived log sequence number (LSN) or archive tail of an archivable log.

Syntax

CLFSUSER_API BOOL SetLogArchiveTail(
  [in]                HANDLE    hLog,
  [in]                PCLFS_LSN plsnArchiveTail,
  [in, out, optional] LPVOID    pReserved
);

Parameters

[in] hLog

A handle to the log that is obtained from CreateLogFile.

The log handle can refer to a dedicated or multiplexed log.

[in] plsnArchiveTail

A pointer to a CLFS_LSN structure that specifies a valid physical LSN in the log.

Note For handles to both a physical log or a log stream, plsnArchiveTail is a physical LSN, because it refers to a record address in the physical log.

[in, out, optional] pReserved

This parameter is reserved and should be set to 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

If there are any archive contexts obtained from PrepareLogArchive that are not terminated with TerminateLogArchive, the change does not take effect until all archives are complete. While there are outstanding archive contexts, only the greatest archive tail is applied.

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