HrESEBackupTruncateLogs Function
Topic Last Modified: 2006-06-12
The HrESEBackupTruncateLogs function examines the storage group log files, and deletes those that are no longer needed to fully restore the storage group.
Applies To
ESEbcli2 DLL Functions Interface
Syntax
HRESULT HrESEBackupTruncateLogs
(
HCCX hccsBackupContext
);
Parameters
- hccsBackupContext
Input parameter. The backup context handle returned by the HrESEBackupPrepare Function in the phccxBackupContext parameter.
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
The ESE examines the logs files for all the currently-attached databases in the storage group. ESE determines which log files are no longer needed to restore the database, and deletes them. At the end of the backup operation, the databases are updated to reflect which log files remain.
Applications that use this function must be run under a user account having Microsoft Windows® server operating systems Backup and Restore privileges.