• Article

HrESEBackupGetLogAndPatchFiles Function

Topic Last Modified: 2006-06-12

The HrESEBackupGetLogAndPatchFiles function returns the list of log and other files related to the storage group that is being backed up.

Applies To

ESEbcli2 DLL Functions Interface

Syntax

HRESULT HrESEBackupGetLogAndPatchFiles
(
        HCCX hccsBackupContext,
        wchar** pwszFiles
);

Parameters

  • hccsBackupContext
    Input parameter. The backup context handle returned by the HrESEBackupPrepare Function in the phccxBackupContext parameter.
  • pwszFiles
    A buffer containing a list of log and other files associated with the storage group.

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 buffer returned in pwszFile contains individual file names separated by a single NULL character. The last file name in the buffer is followed by two consecutive NULL characters. Patch files ending with the extension .pat are only applicable to Microsoft Exchange 2000 Server Service Pack 1 and earlier. Exchange 2000 Server Service Pack 2 and later, and Exchange Server 2003, do not use patch files.

Important

The pwszFile buffer returned by this function is not a NULL-terminated string. Do not attempt to use string-manipulation functions that rely on having a single NULL character that terminates the string, because those functions cannot copy the entire string. This can potentially result in failed backups and corrupted databases.

The memory allocated for pwszFile is freed when the application calls the ESEBackupFree Function.

During a backup session, no additional databases can be opened for backup after this function is called.

Applications that use this function must be run under a user account that has Microsoft Windows® server operating systems Backup and Restore privileges.