enableProgressEvents

enableProgressEvents(increment: Integer);

The enableProgressEvents method of the JadeDatabaseAdmin class enables the notification of operation and progress events for file backups at the progress interval specified in the increment parameter, which represents a percentage of the size of the file.

When operation and progress event notifications are enabled:

• A progress event is notified by each DbFile instance whenever the specified percentage increment of the file has been copied.

• An operation event is notified by each DbFile instance of the backup operation being performed on the file.

For details, see "JadeDatabaseAdmin Class Event Notifications" and "DbFile Class Event Notifications", elsewhere in this chapter.

The following example shows the use of the enableProgressEvents method.

initialise(backupDir: String;
           compress, verify, includeSystemFiles: Boolean;
           overwrite, quiesce: Boolean) updating;
begin
    // Save backup parameters for calls to database backup methods
    defaultDirectory := backupDir;
    compressFiles    := compress;
    verifyFiles      := verify;
    includeSysFiles  := includeSystemFiles;
    overwriteFiles   := overwrite;
    quiescedBackup   := quiesce;
    // Enable backup progress events to occur in increments of 4% or greater
    self.dba.enableProgressEvents(4);
end;