DsSetCurrentBackupLog function

Article
12/11/2020

[This function is available for use in the operating systems specified in the Requirements section. It may be altered or unavailable in subsequent versions. Beginning with Windows Vista, use Volume Shadow Copy Service (VSS) instead.]

The DsSetCurrentBackupLog function sets the current backup log number after a successful restore. Because Active Directory Domain Services only support circular logging, this function is not normally used.

Syntax

HRESULT DsSetCurrentBackupLog(
  _In_ LPCWSTR szServerName,
  _In_ DWORD   dwCurrentLog
);

Parameters

szServerName [in]: Pointer to a null-terminated string that contains the name of the server to set the backup log number for. Preceding backslashes are optional. The server must be the same computer that this function is called from. The server name cannot contain any underscore (_) characters. An example of a server name is "\\server1".
dwCurrentLog [in]: Contains the backup log number to set.

Return value

Returns S_OK if the function is successful or a Win32 or RPC error code otherwise. The following list lists possible error codes.

ERROR_INVALID_PARAMETER: One or more parameters are invalid.
ERROR_NOT_ENOUGH_MEMORY: A memory allocation failure occurred.

Remarks

It is not normally required to call the DsSetCurrentBackupLog function. The backup functions automatically determine and set the last log number backed up. Use DsSetCurrentBackupLog to prevent another incremental backup from succeeding until a full backup is performed.

Requirements

Requirement	Value
Minimum supported client	Windows Vista
Minimum supported server	Windows Server 2008
Header	Ntdsbcli.h
Library	Ntdsbcli.lib
DLL	Ntdsbcli.dll
Unicode and ANSI names	DsSetCurrentBackupLogW (Unicode) and DsSetCurrentBackupLogA (ANSI)