• Article

HrESERestoreCloseFile Function

Topic Last Modified: 2006-06-12

The HrESERestoreCloseFile function closes an open database file.

Applies To

ESEbcli2 DLL Functions Interface

Syntax

HRESULT HrESERestoreCloseFile
(
        HCCX phccxRestoreContext,
        void* hFile
);

Parameters

  • phccxRestoreContext
    Input parameter. A handle to a restore context. The handle is passed to the various restore functions, and contains information about the current restore operations.
  • hFile
    Input parameter. A file handle for the file being restored, returned in the first element of the rghfile parameter returned by the HrESERestoreOpenFile 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.