• Article

HrESEBackupCloseFile Function

Topic Last Modified: 2006-06-12

The HrESEBackupCloseFile function closes the section handle for the file that is being backed up. The section handle was provided by the HrESEBackupOpenFile Function.

Applies To

ESEbcli2 DLL Functions Interface

Syntax

HRESULT HrESEBackupCloseFile
(
        HCCX hccsBackupContext,
        void* hFile
);

Parameters

  • hccsBackupContext
    Input parameter. The backup context handle returned by the HrESEBackupPrepare Function in the phccxBackupContext parameter.
  • hFile
    Input parameter. Specifies the file handle for the file section, as returned in the rghFile array by the HrESEBackupOpenFile Function.

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

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