ESERestoreFreeEnvironment Function

Topic Last Modified: 2006-06-12

The ESERestoreFreeEnvironment function frees memory allocated by the HrESERestoreLoadEnvironment Function.

Applies To

ESEbcli2 DLL Functions Interface

Syntax

HRESULT ESERestoreFreeEnvironment
(
        RESTORE_ENVIRONMENT** ppRestoreEnvironment
);

Parameters

  • ppRestoreEnvironment
    Input parameter. A pointer to the restore environment information, held in a RESTORE_ENVIRONMENT Structure. The returned structure must be freed by calling the ESERestoreFreeEnvironment.

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.