xflminterface IF_BTreeInfoStatus : public XF_RefCount
This class represents the b-tree information status interface. XFLAIM does not provide an implementation of this interface. An application implements this interface so that it can be informed of the progress of methods in the IF_BTreeInfo class that collect information on b-trees in a database. The two methods that report progress back through this status object are collectIndexInfo and collectCollectionInfo. What the application does with this status information is entirely up to the application. (Some obvious examples would be to display the information on the screen, or allow the user to cancel the operation.)
|
Method Summary |
|
RCODE |
infoStatus - Reports the progress of the information gathering process and allows the gathering process to be canceled if desired. |
|
Method Detail |
RCODE infoStatus(
FLMUINT uiCurrLfNum,
FLMBOOL bIsCollection,
char * pszCurrLfName,
FLMUINT uiCurrLevel
FLMUINT64 ui64CurrLfBlockCount,
FLMUINT64 ui64CurrLevelBlockCount,
FLMUINT64 ui64TotalBlockCount);
Reports progress of the current information gathering process. Allows the process to be canceled if desired. If the implementer of this method desires the information gathering process to be canceled, they should return a non-zero RCODE.
Parameters In:
FLMUINT uiCurrLfNum
The number of the current logical file (index or collection) that is being processed. FLMBOOL bIsCollection If TRUE, the current logical file is a collection. If FALSE, it is an index. char * pszCurrLfName The name of the current logical file that is being processed. FLMUINT uiCurrLevel The level of the b-tree that is currently being processed in the logical file. FLMUINT64 ui64CurrLfBlockCount The number of blocks that have been processed thus far in the current logical file. FLMUINT64 ui64CurrLevelBlockCount The number of blocks that have been processed thus far in the current level of the current logical file. FLMUINT64 ui64TotalBlockCount The total number of blocks that have been processed thus far for all b-trees that have been examined.
Parameters Out: none.