HrESERestoreGetEnvironment Function

  • Article

HrESERestoreGetEnvironment Function

This content is no longer actively maintained. It is provided as is, for anyone who may still be using these technologies, with no warranties or claims of accuracy with regard to the most recent product version or service release.

The HrESERestoreGetEnvironment function returns a pointer to the structure that holds information about the restore environment.

Applies To

ESEbcli2 DLL Functions Interface

Syntax



[C++]HRESULT HrESERestoreGetEnvironment
(
    HCCX phccxRestoreContext,
    RESTORE_ENVIRONMENT** ppRestoreEnvironment
);



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.
    • 

  • ppRestoreEnvironment
    
Output parameter. A pointer to the restore environment information, stored in a RESTORE_ENVIRONMENT Structure.
    • 





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.




Send us your feedback about the Microsoft Exchange Server 2003 SDK.


Build: June 2007 (2007.618.1)


© 2003-2006 Microsoft Corporation. All rights reserved. Terms of use.