xflminterface IF_Backup : public XF_RefCount


This interface represents the XFLAIM™  backup object. It extends XF_RefCount.


Method Summary

FLMUINT64  

 getBackupTransId - Get the backup transaction Id.

FLMUINT64

 getLastBackupTransId - Get the last backup transaction Id.

RCODE

 backup - Perform a backup.

RCODE  endBackup - End a backup.

 

Method Detail

getBackupTransId

    FLMUINT64 getBackupTransId ( void);

Get the backup transaction Id.

    Parameters In: none.

    Parameters Out: none.

    See Also: getLastBackupTransId

[Back to Top]


getLastBackupTransId

    FLMUINT64 getLastBackupTransId( void);

Get the last backup transaction Id.

    Parameters In: none.

    Parameters Out: none.

    See Also: getBackupTransId

[Back to Top]


backup

    RCODE backup(

        FLMBYTE *             pszBackupPath,

        IF_BackupClient *     pBackupClient,

        IF_BackupStatus *     pBackupStatus,

        FLMUINT *              puiIncSeqNum);

Begin a backup.

    Parameters In:

FLMBYTE * pszBackupPath A path indicating where to put the backup set.
IF_BackupClient * pBackupClient A pointer to a backup client object for handling backup data streamed to it from the backup method.
IF_BackupStatus * pBackupClient A pointer to a backup status object for reporting backup status events.

    Parameters Out:

FLMUINT * puiIncSeqNum A number representing the backup sequence.

    Example Code: see IF_Db::backupBegin.

    See Also: IF_Db::backupBegin, endBackup

[Back to Top]


endBackup

    RCODE endBackup(  void);

End a backup.

    Parameters In: none.

    Parameters Out: none.

    Example Code: see IF_Db::backupBegin.

    See Also: IF_Db::backupBegin, backup

[Back to Top]