Symbian
Symbian OS Library

SYMBIAN OS V9.3

[Index] [Spacer] [Previous] [Next]



Location: S32BTREE.H
Link against: estor.lib

Class TBtreeToken

class TBtreeToken;

Description

Encapsulates the persistent parameters for a TBtree.

Members

Defined in TBtreeToken:
Clear(), EEmpty, ExternalizeL(), InternalizeL(), IsBroken(), IsEmpty(), IsIntact(), TBtreeToken(), TBtreeToken(), TEmpty, Touch()


Construction and destruction


TBtreeToken()

inline TBtreeToken();

Description

Default constuctor.


TBtreeToken()

inline TBtreeToken(TEmpty);

Description

Constructor that intialises the TBtreeToken for an empty B-tree.

Parameters

TEmpty

[Top]


Member functions


Touch()

inline void Touch();

Description

Marks the B-tree as broken.


IsBroken()

inline TBool IsBroken() const;

Description

Tests if the broken flag has been set on the B-tree.

Return value

TBool

True if the B-tree is broken, otherwise false.


IsIntact()

inline TBool IsIntact() const;

Description

Tests if the broken flag has not been set on the B-tree .

Return value

TBool

True if the B-tree is not broken, otherwise false.


IsEmpty()

inline TBool IsEmpty() const;

Description

Tests if the B-tree is empty.

Return value

TBool

True if the B-tree is empty, otherwise false.


ExternalizeL()

IMPORT_C void ExternalizeL(RWriteStream &aStream) const;

Description

Externalises a TBtreeToken object to a stream.

Parameters

RWriteStream &aStream

Stream to which the object should be externalised.


InternalizeL()

IMPORT_C void InternalizeL(RReadStream &aStream);

Description

Internalises a TBtreeToken object from a stream.

Parameters

RReadStream &aStream

Stream from which the object should be internalised.


Clear()

protected: IMPORT_C void Clear();

Description

[Top]


Member enumerations


Enum TEmpty

TEmpty

Description

Provides a TBtreeToken initialisation flag.

EEmpty