TBtreeFixBase Class Reference

#include <s32btree.h>

Link against: estor.lib

class TBtreeFixBase : public TBtree

Inherits from

Detailed Description

Base class for TBtreeFix, which provides a B-tree for fixed sized entries.

Constructor & Destructor Documentation

TBtreeFixBase ( TBtreeMode, TInt, TInt )

IMPORT_CTBtreeFixBase(TBtreeModeaMode,
TIntanEntrySize,
TIntaKeySize
)[protected]

TBtreeFixBase ( const TBtreeToken &, TBtreeMode, TInt, TInt )

IMPORT_CTBtreeFixBase(const TBtreeToken &aToken,
TBtreeModeaMode,
TIntanEntrySize,
TIntaKeySize
)[protected]

Member Function Documentation

Connect ( MPagePool *, const MBtreeKey * )

IMPORT_C voidConnect(MPagePool *aPool,
const MBtreeKey *aKey
)

Initalises the B-tree with a page pool and key handler.

Parameters
aPoolPage pool to provide storage for the B-tree
aKeyKey handler for the B-tree

ExtractAtL ( const TBtreePos &, TAny * )

IMPORT_C voidExtractAtL(const TBtreePos &aPos,
TAny *anEntry
)const

Gets the entry at the specified position.

Parameters
aPosPosition of the entry to get
anEntryBuffer into which to copy the entry.

ExtractAtL ( const TBtreeMark &, TAny * )

IMPORT_C voidExtractAtL(const TBtreeMark &aMark,
TAny *anEntry
)const

Gets the entry at the specified iterator position.

Parameters
aMarkPosition of the entry to get
anEntryBuffer into which to copy the entry.

InsertL ( TBtreePos &, const TAny *, TAllowDuplicates )

IMPORT_C TBoolInsertL(TBtreePos &aPos,
const TAny *anEntry,
TAllowDuplicatesaDup = ENoDuplicates
)

Inserts an entry into the tree.

Parameters
aPosOn return, the position of the entry inserted
anEntryPointer to the entry to insert
aDupFlag to indicate whether duplicate entries are allowed in the tree
Return Value
True if successful, false if the entry was a duplicate and aDup was set to ENoDuplicates