interface IF

xflminterface IF_RestoreClient : public XF_RefCount

This class represents the restore client interface. It extends XF_RefCount. XFLAIM does not provide an implementation of this interface. It must be implemented by an application. Methods on this object are used by the IF_DbSystem::dbRestore method to read the backed-up data from the location it is stored in. In this way, an application can have a database restored from virtually any media.

Method Summary
`RCODE`	openBackupSet - Method to open an existing database backup set.
`RCODE`	openRflFile - Method to open a RFL (Roll Forward Log) file.
`RCODE`	openIncFile - Method to open an incremental backup file.
`RCODE`	read - Method to read X number of bytes from the backup set.
`RCODE`	close - Method to close a backup set.
`RCODE`	abortFile - Method to abort the current file.

Method Detail

openBackupSet

RCODE openBackupSet( void);

Method called by IF_DbSystem::dbRestore when it wants the application to open the database backup set.

Parameters In: none.

Parameters Out: none.

[Back to Top]

openRflFile

RCODE openRflFile(

FLMUINT uiFileNum);

Method called by IF_DbSystem::dbRestore when it wants the application to open a roll-forward log file to restore.

Parameters In:

FLMUINT uiFileNum
The RFL file number.

Parameters Out: none.

[Back to Top]

openIncFile

RCODE openIncFile(

FLMUINT uiFileNum);

Method called by IF_DbSystem::dbRestore when it wants the application to open an incremental backup file.

Parameters In:

FLMUINT uiFileNum The incremental backup file number.

Parameters Out: none.

[Back to Top]

read

RCODE read(

FLMUINT uiLength,

void * pvBuffer,

FLMUINT * puiBytesRead);

Method called by IF_DbSystem::dbRestore to read data from the backup set. The IF_RestoreClient object should return data from whatever file it was last told to open.

Parameters In:

FLMUINT uiLength Number of bytes of data to read in from the backup set.

Parameters Out:

void * pvBuffer The buffer the backup data is to be read into.

FLMUINT * puiBytesRead The number of bytes that were read.

[Back to Top]

RCODE close( void);

Method called by IF_DbSystem::dbRestore to close the backup set.

Parameters In: none.

Parameters Out: none.

[Back to Top]

abortFile

RCODE abortFile( void);

Method called by IF_DbSystem::dbRestore to abort reading from the current file in the backup set. The IF_RestoreClient object should close the current file and not read any more data from it.

Parameters In: none.

Parameters Out: none.

[Back to Top]

void * pvBuffer	The buffer the backup data is to be read into.
FLMUINT * puiBytesRead	The number of bytes that were read.