HListScheduledBackup (Function)

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

Remark: From version 19, HFSQL is the new name of HyperFileSQL.

Versions 22 and later

This function is now available for iPhone/iPad applications.

This function is now available in Universal Windows 10 App mode.

New in version 22

This function is now available for iPhone/iPad applications.

This function is now available in Universal Windows 10 App mode.

This function is now available for iPhone/iPad applications.

This function is now available in Universal Windows 10 App mode.

Example

arrBck is dynamic array of hBackupDescription
arrBck = HListScheduledBackup(cnt)
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> = HListScheduledBackup(<Connection>)

<Result>: Array of hBackupDescription variables

Array containing the hBackupDescription variables.

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

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

Remarks

Versions 23 and later

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) 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

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) 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.

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) 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.

Component : wd250hf.dll