xflminterface IF_BackupStatus : public XF_RefCount

This class represents the backup status interface. It extends XF_RefCount.  XFLAIM does not provide an implementation of this interface.  Interfaces ending in Status exist to allow the application supply an object that can receive progress/status updates during some other operation.  In the case of IF_BackupStatus, it exists to allow XFLAIM to inform applications of the progress of a currently running backup.  Specifically, it reports how much has been done and how much remains.  What the application does with this information is entirely up to the application.  (Some obvious examples would be to display the information on the screen, or email the administrator when the backup completes.)

backupStatus

    RCODE backupStatus(

        FLMUINT64    ui64BytesToDo

        FLMUINT64    ui64BytesDone);

Reports how much of the current backup has been completed and how much remains.

    Parameters In:

FLMUINT64 ui64BytesToDo	The number of bytes remaining in the current backup job.
FLMUINT64 ui64BytesToDo	The number of bytes completed.

    Parameters Out: none.

    See Also:

[Back to Top]