<Connection variable>.ListScheduledBackup (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

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

Necessary rights

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

<Connection variable>.ListScheduledBackup (Function)

In french: <Variable Connexion>.ListeSauvegardePlanifiée

Available only with this kind of connection

Lists the full and differential backups that have been scheduled on HFSQL Client/Server. The list of scheduled backups is returned in an array of advanced hBackupDescription variables.

Example

// Describe the connection
MyConnection is Connection

arrBck is dynamic array of hBackupDescription
arrBck = MyConnection.ListScheduledBackup()
hBck is hBackupDescription

FOR EACH hBck OF arrBck
Trace("_______________________________________________________")
Trace("hBck.Identifier = " + hBck.Identifier)
Trace("hBck.Description = " + hBck.Description)
Trace("hBck.Destination = " + hBck.Destination)
Trace("hBck.LimitNumberBackups = " + hBck.LimitNumberBackups)
Trace("hBck.Source = " + hBck.Source)
Trace("hBck.User = " + hBck.User)

Trace("hBck.SchedulingFull.Month = " + ...
hBck.SchedulingFull.Month)
Trace("hBck.SchedulingFull.DayOfMonth = " + ...
hBck.SchedulingFull.DayOfMonth)
Trace("hBck.SchedulingFull.Hour = " + ...
hBck.SchedulingFull.Hour)
Trace("hBck.SchedulingFull.Minute = " + ...
hBck.SchedulingFull.Minute)
Trace("hBck.SchedulingFull.DayOfWeek = " + ...
hBck.SchedulingFull.DayOfWeek)
Trace("hBck.SchedulingFull.DayOfMonthOrDayOfWeek = " + ...
hBck.SchedulingFull.DayOfMonthOrDayOfWeek)

Trace("hBck.SchedulingDifferential.Month = " + ...
hBck.SchedulingDifferential.Month)
Trace("hBck.SchedulingDifferential.DayOfMonth = " + ...
hBck.SchedulingDifferential.DayOfMonth)
Trace("hBck.SchedulingDifferential.Hour = " + ...
hBck.SchedulingDifferential.Hour)
Trace("hBck.SchedulingDifferential.Minute = " + ...
hBck.SchedulingDifferential.Minute)
Trace("hBck.SchedulingDifferential.DayOfWeek = " + ...
hBck.SchedulingDifferential.DayOfWeek)
Trace("hBck.SchedulingDifferential.DayOfMonthOrDayOfWeek = " + ...
hBck.SchedulingDifferential.DayOfMonthOrDayOfWeek)

END

Syntax

<Result> = <Connection>.ListScheduledBackup()

<Result>: Array of hBackupDescription variables

Array containing the hBackupDescription variables.

<Connection>: Connection variable

Name of the Connection variable that describes the connection for which the scheduled backups must be listed.

Remarks

Necessary rights

To list the scheduled backups, the user or the group must have:

for each database affected by the backup, the rights to perform backups (hRightsBackup constant) or the rights to connect (hRightsConnection or hRightsEncryptedConnection constant).
for a full server backup, the rights to perform backups (hRightsBackup constant) on the server.

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>.ModifyDatabaseRights or <Connection variable>.ModifyServerRights.

Component: wd280hf.dll