• Rights required to retrieve a backup
WindowsLinuxUniversal Windows 10 AppJavaReports and QueriesUser code (UMC)
WindowsLinuxPHPWEBDEV - Browser code
AndroidAndroid Widget iPhone/iPadIOS WidgetApple WatchMac CatalystUniversal Windows 10 App
Stored procedures
Retrieves locally the content of a compressed backup (in ZIP format) performed on an HFSQL server.
// Describe the connection
MyConnection is Connection
MyConnection.RetrieveBackup(BackupID, "C:\temp\", PROGBAR_Progress)
<Result> = <Connection>.RetrieveBackup(<Backup> , <Destination file> [, <Progress Bar>])
<Result>: Boolean
  • True if the backup was retrieved,
  • False if a problem occurs. HErrorInfo is used to identify the error.
<Connection>: Connection variable
Name of the Connection variable that describes the connection with the backup to retrieve.
<Backup>: Integer or character string
Backup to retrieve. Can correspond to:
  • Backup identifier. This identifier can correspond to the identifier of full backup or to the identifier of differential backup.
    During an immediate backup, this identifier is returned by <Connection variable>.Backup. This identifier can also be returned by <Connection variable>.InfoBackup.
    In a scheduled backup, this identifier corresponds to the Identifier property of the hBackupDescription variable.
  • Path and name of backup. This name was specified during the backup. This name can also be returned by <Connection variable>.InfoBackup. If this name corresponds to a relative path, the backup will be sought in the "Backup" subdirectory of HFSQL server. To specify the directory of Manta service, simply use "%%EXE%%".
<Destination file>: Character string
Path and name of local file in which the backup will be retrieved.
In the case of a full backup, the destination file is a zip file (the ".zip" extension must be specified in the file name.
<Progress Bar>: Optional control name, optional window name or optional integer
  • Name of the window where the progress bar will be displayed or name of the Progress Bar control.
  • Handle of the window that displays the progress bar.
WEBDEV - Server code This parameter is ignored.

Rights required to retrieve a backup

To retrieve a backup, the user or the group must have the rights to perform backups (hRightsBackup constant). These rights apply to the servers and to the databases. For example, to perform a full server backup, you must have the rights to perform backups at server level.
To find out whether these rights are granted to a user or to a group, use <Connection variable>.InfoServerRights or <Connection variable>.InfoDatabaseRights.
To modify the rights granted to a user or to a group of users, use <Connection variable>.ModifyServerRights or <Connection variable>.ModifyDatabaseRights.
Component: wd270hf.dll
Minimum version required
  • Version 25
This page is also available for…
Click [Add] to post a comment