SetLogArchiveTail function

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

Syntax


BOOL WINAPI SetLogArchiveTail(
  _In_        HANDLE    hLog,
  _In_        PCLFS_LSN plsnArchiveTail,
  _Inout_opt_ LPVOID    pReserved
);

Parameters

hLog [in]

A handle to the log that is obtained from CreateLogFile.

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

plsnArchiveTail [in]

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.
 
pReserved [in, out, optional]

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:

ERROR_ACCESS_DENIED
ERROR_INVALID_HANDLE
ERROR_INVALID_PARAMETER
ERROR_LOG_EPHEMERAL

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

Minimum supported client

Windows Vista [desktop apps only]

Minimum supported server

Windows Server 2003 R2 [desktop apps only]

Header

Clfsw32.h

Library

Clfsw32.lib

DLL

Clfsw32.dll

See also

CLFS_LSN
Common Log File System Functions
OVERLAPPED
RemoveLogContainer
RemoveLogContainerSet

 

 

Community Additions

ADD
Show: