HExecuteScheduledBackup (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help / WLanguage / Managing databases / HFSQL / HFSQL Client/Server functions

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

HExecuteScheduledBackup (Function)

In french: HExécuteSauvegardePlanifiée

Available only with this kind of connection

Forces the execution of a scheduled backup. The scheduled backup is run during the call to the function instead of being run according to its scheduling.

Example

// Describe the connection
DatabaseConnection is Connection

hBck is hBackupDescription
hBck.WithIndex = False // Backup without index
hBck.Source = DatabaseConnection.Database
hBck.Description = DatabaseConnection.Database
hBck.SchedulingFull.Month = "12"
hBck.SchedulingFull.Hour = "22"
hBck.SchedulingDifferential.Month = "12"
hBck.SchedulingDifferential.Hour = "23"
// Create the scheduled backup
HAddScheduledBackup(DatabaseConnection, hBck)
// Immediate execution
IF HExecuteScheduledBackup(DatabaseConnection, hBck.Identifier, False) = False THEN
	Error("HExecuteScheduledBackup failed (full backup): " + ...
			HErrorInfo(hErrFullDetails))
END

Syntax

<Result> = HExecuteScheduledBackup(<Connection> , <Backup identifier> [, <Type of backup>])

<Result>: Boolean

True if the scheduled backup was immediately triggered,
False if an error occurred.

<Connection>: Character string or Connection variable

Connection for which the scheduled backup must be performed. This connection corresponds to:
the name of the connection defined in the data model editor or with HDescribeConnection or HOpenConnection.
the name of a variable of type Connection.

<Backup identifier>: Integer

Identifier of the scheduled backup to run.

<Type of backup>: Optional boolean

Type of backup to perform:
True (default value): Differential backup.
False: Full backup.
Remark: A differential backup can be performed only if the backup task includes a differential scheduling.

Component: wd300hf.dll