DsRestorePrepare 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 DsRestorePrepare function connects to the specified directory server and prepares it for the restore operation.

Syntax

HRESULT DsRestorePrepare(
  _In_  LPCWSTR szServerName,
  _In_  ULONG   rtFlag,
  _In_  PVOID   pvExpiryToken,
  _In_  DWORD   cbExpiryTokenSize,
  _Out_ HBC     *phbc
);

Parameters

szServerName [in]: Pointer to a null-terminated string that contains the name of the server to restore. 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".
rtFlag [in]: Specifies the type of restoration to perform. This can be zero or one of the following values.
RESTORE_TYPE_CATCHUP: Default. The restored version is reconciled through the standard reconciliation logic so that the restored DIT can synchronize with other enterprise server computers.
RESTORE_TYPE_AUTHORATATIVE: Not Supported.
RESTORE_TYPE_ONLINE: Not Supported. Restoration is performed when NTDS is online.

pvExpiryToken [in]

Pointer to the expiry token associated with the backup being restored. This token was obtained from the DsBackupPrepare function when the directory was backed up.

If this parameter is NULL, the handle returned in phbc can only be used to obtain the restoration directories with the DsRestoreGetDatabaseLocations function. The handle cannot be used for any other restoration functions.

cbExpiryTokenSize [in]

Contains the size, in bytes, of the expiry token in pvExpiryToken.

phbc [out]

Pointer to an HBC value that receives the handle for the restore. This handle is used when calling other Directory Service restore functions, such as DsBackupOpenFile and DsRestoreEnd.

Return value

If successful, returns a standard HRESULT codes; otherwise, a failure code is returned.

Remarks

The DsRestorePrepare function requires that the caller is a member of the Administrators group on the server.

DsRestorePrepare may be used with or without a token provided. If the token is provided, it is checked for expiration, and all operations are allowed on the context returned. If the token is not provided, the context returned is restricted, and may be used only for the DsRestoreGetDatabaseLocations function. It may not be used for the DsRestoreRegister function.

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	DsRestorePrepareW (Unicode) and DsRestorePrepareA (ANSI)