Symbian
Symbian Developer Library

SYMBIAN OS V9.4

Feedback

[Index] [Previous] [Next]

#include <S32BTREE.H>
Link against: estor.lib

Class TBtreeKey

class TBtreeKey : public MBtreeKey;

Description

Derivation

Members

Defined in TBtreeKey:


Construction and destruction


TBtreeKey()

IMPORT_C TBtreeKey();

Description


TBtreeKey(TInt)

IMPORT_C TBtreeKey(TInt aLength);

Description

Parameters

TInt aLength


TBtreeKey(TInt,TKeyCmpText)

IMPORT_C TBtreeKey(TInt anOffset, TKeyCmpText aType);

Description

Parameters

TInt anOffset

TKeyCmpText aType


TBtreeKey(TInt,TKeyCmpText,TInt)

IMPORT_C TBtreeKey(TInt anOffset, TKeyCmpText aType, TInt aLength);

Description

Parameters

TInt anOffset

TKeyCmpText aType

TInt aLength


TBtreeKey(TInt,TKeyCmpNumeric)

IMPORT_C TBtreeKey(TInt anOffset, TKeyCmpNumeric aType);

Description

Parameters

TInt anOffset

TKeyCmpNumeric aType

[Top]


Member functions


Key(const TAny *)const

IMPORT_C virtual const TAny* Key(const TAny *anEntry) const;

Description

Gets the key value for an entry.

Parameters

const TAny *anEntry

Object for which to get the key value

Return value

const TAny *

Pointer to the key value


Compare(const TAny *,const TAny *)const

IMPORT_C virtual TInt Compare(const TAny *aLeft, const TAny *aRight) const;

Description

Orders two keys.

Parameters

const TAny *aLeft

Pointer to first key

const TAny *aRight

Pointer to second key

Return value

TInt

Positive, if the first key is after the second key; negative, if the first key is before the second key; zero, if the keys are equal


Between(const TAny *,const TAny *,TBtreePivot &)const

IMPORT_C virtual void Between(const TAny *aLeft, const TAny *aRight, TBtreePivot &aPivot) const;

Description

Gets the midpoint between two keys.

The generated midpoint will be greater or equal to aLeft (by a comparison performed by the TBtreeKey::Compare(const TAny *,const TAny *)const function), and less than aRight.

Parameters

const TAny *aLeft

First key

const TAny *aRight

Second key

TBuf8 &aPivot

On return, the midpoint between the two keys

[Top]


Member data


iKeyOffset

protected: TInt iKeyOffset;

Description


iCmpType

protected: TInt iCmpType;

Description


iKeyLength

protected: TInt iKeyLength;

Description