HrESEBackupOpenFile Function

Topic Last Modified: 2006-06-12

The ESEBackupOpenFile function opens the specified database file.

Applies To

ESEbcli2 DLL Functions Interface

Syntax

HRESULT ESEBackupOpenFile
(
        HCCX hccsBackupContext,
        wchar* wszFileName,
        unsigned long cbReadHintSize,
        unsigned long cSections,
        void** rghFile,
        __int64* rgliSectionSize
);

Parameters

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

• wszFileName
  Input parameter. The name of the file to open.

• cbReadHintSize
  Input parameter. The suggested buffer size to allocate for transferring data between the Exchange Storage Engine (ESE) and the backup application. If there is not enough memory available, or if the backup is running remotely, this parameter is ignored.

• cSections
  Input parameter. The number of file sections the function should return. This parameter should always be 1.

• rghFile
  An array of file handles. There will be only one element in the array, and it points to the section to read.

• rgliSectionSize
  Output parameter. An array of elements indicating the size of each section to read. There will be only one element in the array.

Return Value

The following return codes can be returned. To retrieve the error string for an 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

Important

Only one section is supported. The cSections parameter must be 1, and there will be only one element in the rghFile and rgliSectionSize arrays.

Only databases specified with HrESEBackupPrepare, or returned by HrESEBackupGetLogAndPatchFiles, can be opened using this function.

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