IMSAdminBase::EnumBackups

The IMSAdminBase::EnumBackups method enumerates the metabase backups in a specified backup location, or in all backup locations. Repeated calls to this method, increasing dwMDEnumIndex from 0, will return information for each metabase backup in the backup location until HRESULT_FROM_WIN32 (ERROR_NO_MORE_ITEMS) is returned.

HRESULT EnumBackups( 
  LPWSTR pszMDBackupLocation, 
  DWORD __RPC_FAR *pdwMDVersion, 
  PFILETIME pftMDBackupTime, 
  DWORD dwMDEnumIndex 
);

Parameters

pszMDBackupLocation: On input, a buffer of length MD_BACKUP_MAX_LEN times sizeof(WChar) containing an empty string or a string of up to MD_BACKUP_MAX_LEN unicode characters that identifies the backup location. If an empty string is input, the method will enumerate backups in all backup locations, returning the backup location in this parameter. If a backup location is specified on input, only backups in the specified backup location will be enumerated.
pdwMDVersion: Receives the version number of the backup.
pftMDBackupTime: Receives the date and time of the backup, in Universal Time Coordinate (UTC), formerly GMT.
dwMDEnumIndex: Specifies the index number of the backup to be enumerated.

Return Values

Returns an HRESULT that contains one of the following values, or any errors from the file system converted to HRESULT.

Value	Description
ERROR_INVALID_NAME	Specified name is invalid.
ERROR_NO_MORE_ITEMS	No more items to enumerate.
ERROR_NOT_ENOUGH_MEMORY	Insufficient memory to perform the operation.
ERROR_SUCCESS	The method succeeded.