HRetrieveBackup (Function)

WINDEV, WEBDEV AND WINDEV MOBILE
ONLINE HELP

Version:

Home | Sign in | English

Help

WLanguage

Management of databases

HFSQL functions

HFSQL Client/Server functions

HRetrieveBackup

Presentation

Example

Rights required to retrieve a backup

HAddScheduledOptimization

HCS.Timeout (Variable)

HDeleteScheduledBackup

HDeleteScheduledOptimization

HExecuteScheduledBackup

HExecuteScheduling

HInfoBackup

HInfoDatabaseProperty

HListScheduledOptimization

HModifyDatabaseProperty

HModifyDatabaseRights

HModifyFileProperty

HModifyFileRights

HModifyGroup

HModifyScheduledBackup

HModifyScheduledOptimization

HModifyScheduling

HModifyServerProperty

HNotifAddEmailRecipient

HNotifConfigure

HNotifDeleteCCRecipient

HNotifDeleteEmailRecipient

HNotifListCCRecipient

HNotifListEmailRecipient

Rights required to retrieve a backup

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

HRetrieveBackup (Function)

In french: HRécupèreSauvegarde

Available only with this kind of connection

Retrieves locally the content of a compressed backup (in ZIP format) performed on a HFSQL server.

Example

HRetrieveBackup(Cnt, BackupID, "C:\temp", PROGBAR_Progress)

Syntax

<Result> = HRetrieveBackup(<Connection Name> , <Backup> , <Destination Directory> [, <Progress bar>])

<Result>: Boolean

True if the backup was retrieved,
False if a problem occurred. HErrorInfo is used to identify the error.

<Connection Name>: Character string (with or without quotes)

Name of connection to the server containing the backup to retrieve. This connection was defined in the data model editor, or by HDescribeConnection or HOpenConnection.

<Backup>: Integer or character string

Backup to retrieve. Can correspond to:
Identifier of backup. 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 HBackup. This identifier can also be returned by HInfoBackup.
During a scheduled backup, this identifier corresponds to the ..Identifier property of hBackupDescription variable.
Path and name of backup. This name was specified during the backup. This name can also be returned by HInfoBackup. If this name corresponds to a relative path, the backup will be sought in the "Backup" sub-directory of HFSQL server. To specify the directory of Manta service, all you have to do is use "%%EXE%%".

<Destination Directory>: Character string (with quotes)

Local directory where the backup will be retrieved.

<Progress bar>: Optional character string (with or without quotes) or optional integer

Name of window where the progress bar will be displayed or name of Progress Bar control.
Identifier (Handle) of window that displays the progress bar.
This parameter is ignored.

Remarks

Versions 23 and later

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 HInfoServerRights or HInfoDatabaseRights.

To modify the rights granted to a user or to a group of users, use HModifyServerRights or HModifyDatabaseRights.

New in version 23

Rights required to retrieve a backup

To find out whether these rights are granted to a user or to a group, use HInfoServerRights or HInfoDatabaseRights.

To modify the rights granted to a user or to a group of users, use HModifyServerRights or HModifyDatabaseRights.

Rights required to retrieve a backup

To find out whether these rights are granted to a user or to a group, use HInfoServerRights or HInfoDatabaseRights.

To modify the rights granted to a user or to a group of users, use HModifyServerRights or HModifyDatabaseRights.

Component : wd240hf.dll