DsBackupClose function

[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 DsBackupClose function closes a backup file opened with the DsBackupOpenFile function. For each backup handle, only one file can be opened at a time, so this function closes the currently open file.

Syntax

HRESULT DsBackupClose(
  _In_ HBC hbc
);

Parameters

hbc [in]

Contains the backup context handle obtained with the DsBackupPrepare function.

Return value

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

ERROR_INVALID_PARAMETER

hbc is not valid.

hrInvalidHandle

No file is currently open.

Requirements

Requirement Value
Minimum supported client
Windows Vista
Minimum supported server
Windows Server 2008
Header
Ntdsbcli.h
Library
Ntdsbcli.lib
DLL
Ntdsbcli.dll

See also

DsBackupOpenFile

DsBackupPrepare

Backing Up an Active Directory Server

Directory Backup Functions