enableByteProgressEvents

enableByteProgressEvents(increment: Integer);

The enableByteProgressEvents 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 number of bytes. A value of zero (0) for the increment parameter specifies the lowest allowed value of 128K bytes.

When operation and progress event notifications are enabled:

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

The following example shows the use of the enableByteProgressEvents 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 1000000 bytes
    self.dba.enableByteProgressEvents(1000000);
end;

Enabling operation and progress notification is likely to have some impact on the elapsed time of file backups.