• Article

HrESEBackupRestoreGetRegistered Function

Topic Last Modified: 2006-06-12

The HrESEBackupRestoreGetRegistered function returns an array of server application names that are registered for backup and restore on the specified computer.

Applies To

ESEbcli2 DLL Functions Interface

Syntax

HRESULT HrESEBackupRestoreGetRegistered
(
        wchar* wszServerName,
        wchar* wszDisplayName,
        unsigned long fFlags,
        unsigned long* pcRegisteredInfo,
        ESE_REGISTERED_INFO** paRegisteredInfo
);

Parameters

  • wszServerName
    Input parameter. Points to a string containing the Network Basic Input/Output System (NetBIOS) name of the computer running Microsoft® Exchange.
  • wszDisplayName
    Input parameter. A string specifying the name by which to filter the list of registered applications that is returned. Only applications with the specified display name are returned. To return all registered applications, this parameter should be NULL.
  • fFlags
    Input parameter. Specifies what types of applications to return. Can contain the following bit-mapped flags: ESE_REGISTER_BACKUP (0x00000001), ESE_REGISTER_ONLINE_RESTORE (0x00000002), ESE_REGISTER_OFFLINE_RESTORE (0x00000004), and ESE_REGISTER_SNAPSHOT_BACKUP (0x00000010). Applications that are registered for the specified operations will be returned. When this parameter is zero, all registered applications are returned.
  • pcRegisteredInfo
    Output parameter. A pointer to the count of registered applications returned in the paRegisteredInfo parameter.
  • paRegisteredInfo
    Output parameter. An array of elements describing the existing registered applications. Each element is an ESE_REGISTERED_INFO 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

This function returns an array of server applications that are registered for backup and restore on the specified server. The applications returned can be filtered using the wszDisplayName and fFlags parameters. However, ESE supports only one application: "Microsoft Exchange Server". The array elements returned indicate the services on the Exchange server that can be backed up and restored, and are limited to the information store ("Microsoft Information Store"), the Site Replication service ("Microsoft Site Replication Service"), and the Key Management service ("Microsoft Key Management Service").

After use, the structure pointed to by the pBackupNodeTree return parameter must be freed by calling the ESEBackupRestoreFreeRegisteredInfo Function.

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