ESEbcli2 DLL Functions Interface
Topic Last Modified: 2007-02-08
This interface is used for creating applications that back up and restore Microsoft® Exchange Server 2007 databases.
CLSID
25150F47-5734-11D2-A593-00C04F990D8A
Extends
IDispatch
Member Summary
The following table lists the methods of the ESEbcli2 DLL Functions interface.
| Name | Description |
|---|---|
The ESEBackupFree function frees memory allocated by HrESEBackupGetLogAndPatchFiles, HrESEBackupGetTruncateLogFiles, HrESERestoreLoadEnvironment, HrESERestoreAddDatabase, and HrESERestoreGetEnvironment. |
|
The ESEBackupFreeInstanceInfo function frees the structures and memory allocated by HrESEBackupPrepare Function. |
|
The ESEBackupOpenFile function opens the specified database file. |
|
The ESEBackupRestoreFreeNodes function frees the memory used by the structure returned by the HrESEBackupRestoreGetNodes Function. |
|
The ESEBackupRestoreFreeRegisteredInfo function frees the memory used by the structure returned by the HrESEBackupRestoreGetRegistered Function. |
|
The ESERestoreFree function frees memory buffers allocated by other restore functions. |
|
The ESERestoreFreeEnvironment function frees memory allocated by the HrESERestoreLoadEnvironment Function. |
|
The HrESEBackupCloseFile function closes the section handle for the file that is being backed up. The section handle was provided by the HrESEBackupOpenFile Function. |
|
The HrESEBackupEnd function frees all of the resources held for the backup context that is specified. |
|
The HrESEBackupGetDependencyInfo function retrieves the names of applications and services that the specified service relies upon. Data for those applications should be backed up with the Exchange Storage Engine (ESE) application data to ensure consistency of the application and its dependencies during restore. |
|
The HrESEBackupGetLogAndPatchFiles Function function returns the list of log and other files related to the storage group that is being backed up. |
|
The HrESEBackupGetTruncateLogFiles function returns the list of log files related to the storage group that is being backed up. The log files indicated will be deleted after they are backed up. |
|
The HrESEBackupInstanceEnd Function function finishes the backup process for a storage group. |
|
The HrESEBackupPrepare function opens the connection to Exchange 2007. The Exchange server returns information about the storage groups that can be backed up. |
|
The HrESEBackupReadFile function reads data in the application buffer. |
|
The HrESEBackupRestoreGetNodes function returns a tree of nodes that lists the Exchange 2007 computers in the current domain that can be backed up or restored. |
|
The HrESEBackupRestoreGetRegistered function returns an array of server application names that are registered for backup and restore on the specified computer. |
|
The HrESEBackupSetup function informs the ESE that the specified database is to be backed up. |
|
The HrESEBackupTruncateLogs function examines the storage group log files, and deletes those that are no longer needed to fully restore the storage group. |
|
The HrESERestoreAddDatabase function informs the ESE that the specified database is to be restored. This function, or HrESERestoreAddDatabaseNS, must be called for each database in the storage group that is being restored. |
|
The HrESERestoreAddDatabaseNS function informs the ESE that the specified database is to be restored. This function, or HrESERestoreAddDatabase, must be called for each database in the storage group that is being restored. |
|
The HrESERestoreClose function informs the ESE that the files have been completely restored from the backup storage media. This does not instruct the ESE to begin recovery. |
|
The HrESERestoreCloseFile function closes an open database file. |
|
The HrESERestoreComplete function informs the ESE application that the database files have been restored, and that the application can now recover the files. Exchange 2007 will then attempt to recover the databases and bring them to a consistent state. |
|
The HrESERestoreGetEnvironment function returns a pointer to the structure that holds information about the restore environment. |
|
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. |
|
The HrESERestoreOpen Function function opens the connection to Exchange 2007. The ESE returns a context handle, and the restore log path if none is specified. |
|
The HrESERestoreOpenFile function instructs the ESE to open the specified database or log file for restore. This function must be called for each file being restored. Note that for most file types, this function will respond indicating that the file is to be replaced using normal file-system operations. However, it is important that you tell ESE which database log files are being restored. |
|
The HrESERestoreReopen function opens the connection to Exchange 2007, and loads the restore environment from the folder specified in wszRestoreLogPath. The ESE returns a context handle. |
|
The HrESERestoreSaveEnvironment function saves to disk the in-memory state of the restore operation. |
|
The HrESERestoreWriteFile function writes data to the specified database file. |
|
The HrESESnapshotStart function should not be used to create backup and restore applications. |
|
The HrESESnapshotStop function should not be used to create backup and restore applications. |
Remarks
The esebcli2.dll is a non-dual dynamic-link library (DLL). For this reason, C/C++ must be used to access the backup and restore functions. Use the Microsoft® Windows® LoadLibrary function to load the DLL.