HrESEBackupInstanceEnd Function

Topic Last Modified: 2006-06-12

The HrESEBackupInstanceEnd function finishes the backup process for a storage group.

Applies To

ESEbcli2 DLL Functions Interface

Syntax

HRESULT HrESEBackupInstanceEnd
(
        HCCX hccsBackupContext,
        unsigned long fFlags
);

Parameters

• hccsBackupContext
  Input parameter. The backup context handle returned by the HrESEBackupPrepare Function in the phccxBackupContext parameter.

• fFlags
  Input parameter. Bit-mapped flags specify whether the backup completed successfully. The following values are accepted: ESE_BACKUP_INSTANCE_END_ERROR (0x00000000) and ESE_BACKUP_INSTANCE_END_SUCCESS (0x00000001).

Return Value

The following return codes can be returned. To retrieve the error string for an Exchange Storage Engine (ESE) error, use the standard FormatMessage function. For the general errors hrErrorFromESECall and hrErrorFromCallbackCall, more information about the error is available using the standard GetLastError function.

S_OK	Success.
ESE-specific error codes	ESE-specific error codes, as defined in esebkmsg.h.
Other	Other Microsoft® Win32® or remote procedure call (RPC) errors.

Remarks

Call this function when the backup has completed, to inform the ESE whether the backup completed successfully. After calling this function, other processes are allowed to attach or detach from the storage group.

Applications that use this function must be run under a user account that has Microsoft Windows® server operating systems Backup and Restore privileges.