hBackup |
Backup handle that was returned from FlmDbBackupBegin(). |
pszBackupPath |
This specifieds the directory where FlmDbBackup() is to create a backup file set for the backed up data. The files in the backup set will be named 00000001.64, 00000002.64, etc. This parameter is only used if the fnWrite parameter is NULL. If fnWrite is non-NULL, all backed up data will be passed to that function to be written to a backup medium. |
pszPassword |
Password used to shroud the database encryption key in the backup. If NULL, the database encryption key will remain wrapped in the NICI local storage key. A NULL password means that the backup can only be restored to the same server the backup was taken from, because the database key can only be unwrapped using the NICI local storage key of that server. |
fnWrite |
This is the callback function that FlmDbBackup() will call to write data to the backup medium (tape, disk, etc.). If NULL, FlmDbBackup() will create a backup file set in the directory specified by the pszBackupPath parameter. If a callback function is specified, the application will also want to have a corresponding implementation for the F_Restore class so that it can read data back during a FlmDbRestore() operation. |
fnStatus |
This is a callback function that FlmDbBackup() calls to report backup progress. |
pvAppData |
Pointer to application data. This pointer will be passed into the fnWrite callback function as well as the fnStatus callback function whenever they are called. |
puiIncSeqNum |
If the backup is an incremental backup, this returns the incremental backup sequence number. |