DsRestoreRegisterComplete 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. Use Volume Shadow Copy Service (VSS) instead.]

The DsRestoreRegisterComplete function is called to unlock an Active Directory server after a restore operation is complete. This function is counterpart to the DsRestoreRegister function.

Syntax

HRESULT DsRestoreRegisterComplete(
  _In_ HBC     hbc,
  _In_ HRESULT hrRestoreState
);

Parameters

hbc [in]: Contains the restoration context handle obtained with the DsRestorePrepare function.
hrRestoreState [in]: Contains the final status of the restore operation. This parameter should contain S_OK if the restore operation was successful or an error code otherwise.

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_ACCESS_DENIED: The caller does not have the proper access privileges to call this function. The DsSetAuthIdentity function can be used to set the credentials to use for the backup and restore functions.

Remarks

Before you restart the domain controller, call this function to provide the status of the restore operation. If the status is not successful, the directory service will not start until a valid database has been restored. This function completes the restore operation and allows Active Directory Domain Services to start.

Requirements

Requirement	Value
Minimum supported client	None supported
Minimum supported server	None supported
End of client support	None supported
End of server support	None supported
Header	Ntdsbcli.h
Library	Ntdsbcli.lib
DLL	Ntdsbcli.dll