RESTORE_ENVIRONMENT Structure

RESTORE_ENVIRONMENT Structure

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 RESTORE_ENVIRONMENT structure contains information about the restore operation in progress. This structure is initialized by the HrESERestoreLoadEnvironment Function.

Applies To

ESEbcli2 DLL Functions Interface

Syntax

typedef struct {
wchar *m_wszRestoreLogPath;
wchar *m_wszSrcInstanceName;
unsigned long m_cDatabases;
wchar **m_wszDatabaseDisplayName;
GUID *m_rguidDatabase;
wchar *m_wszRestoreInstanceSystemPath;
wchar *m_wszRestoreInstanceLogPath;
wchar *m_wszTargetInstanceName;
wchar **m_wszDatabaseStreamsS;
wchar **m_wszDatabaseStreamsD;
unsigned long m_ulGenLow;
unsigned long m_ulGenHigh;
wchar *m_wszLogBaseName;
time_t m_timeLastRestore;
RECOVER_STATUS m_statusLastRecover;
HRESULT m_hrLastRecover;
time_t m_timeLastRecover;
wchar *m_wszAnnotation;

} RESTORE_ENVIRONMENT;

Members

  • m_wszRestoreLogPath
    The path to the location where the restore environment is stored.
  • m_wszSrcInstanceName
    The Exchange Storage Engine (ESE) instance that was backed up.
  • m_cDatabases
    The number of databases that have been restored.
  • m_wszDatabaseDisplayName
    An array of pointers to strings that contain the display names of the databases being restored. The array contains the number of elements indicated in m_cDatabases.
  • m_rguidDatabase
    An array of globally unique identifiers (GUIDs) that identify the databases that are being restored. The array contains the number of elements indicated in m_cDatabases.
  • m_wszRestoreInstanceSystemPath
    The path to the files for the ESE instance that will be performing the database recovery after the file restore has completed.
  • m_wszRestoreInstanceLogPath
    The path to the log files for the ESE instance that will be performing the database recovery after the file restore has completed.
  • m_wszTargetInstanceName
    The name of the running ESE instance. This is used to locate logs that were generated after the backup was performed, that need to be replayed against the recovered database to bring the database as up-to-date as possible.
  • m_wszDatabaseStreamsS
    An array of pointers. Each array element points to a buffer containing NULL-separated strings that specify the source stream and other database file names. The last string is followed by two NULL characters. The m_wszDatabaseStreamsS array contains the number of elements indicated in m_cDatabases.
  • m_wszDatabaseStreamsD
    An array of pointers. Each array element points to a buffer containing NULL-separated strings that specify the destination stream and other database file names. The last string is followed by two NULL characters. The m_wszDatabaseStreamsS array contains the number of elements indicated in m_cDatabases.
  • m_ulGenLow
    The number of the lowest (oldest) database log file.
  • m_ulGenHigh
    The number of the highest (newest) database log file.
  • m_wszLogBaseName
    The base name of the database log files.
  • m_timeLastRestore
    The time when the restore environment was saved.
  • m_statusLastRecover
    The status of the restore process after the last operation. This can be one of the following values: recoverInvalid (0), recoverNotStarted (1), recoverStarted (2), or recoverEnded (3).
  • m_hrLastRecover
    If m_statusLastRecover is recoverEnded (3), this member contains the HRESULT returned in the last recover operation.
  • m_timeLastRecover
    If m_statusLastRecover is recoverEnded (3), this member indicates when the last recover operation was performed.
  • m_wszAnnotation
    The annotation passed to HrESERestoreOpen in the wszServiceAnnotation parameter.

Structure Information

Minimum availability Exchange 2000 Server
Minimum operating systems Windows 2000

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.