HrESERestoreLoadEnvironment Function

Topic Last Modified: 2006-06-12

The HrESERestoreLoadEnvironment function loads the stored restore environment file into a structure in memory. This function is not necessary for the restore or recovery operations. Instead, this function enables applications to easily determine the status and settings for an ongoing restore operation.

Applies To

ESEbcli2 DLL Functions Interface

Syntax

HRESULT HrESERestoreLoadEnvironment
(
        wchar* wszServerName,
        wchar* wszRestoreLogPath,
        RESTORE_ENVIRONMENT** ppRestoreEnvironment
);

Parameters

• wszServerName
  Input parameter. The Network Basic Input/Output System (NetBIOS) name of the computer where the restore environment file is stored.

• wszRestoreLogPath
  Input parameter. The folder where the restore operation is storing its logs and environment files.

• ppRestoreEnvironment
  Output parameter. A pointer to the restore environment information, held in a RESTORE_ENVIRONMENT Structure. The returned structure must be freed by calling the ESERestoreFreeEnvironment 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.