Symbian Developer Library

SYMBIAN OS V6.1 EDITION FOR C++

[Index] [Glossary] [Previous] [Next]

 » Symbian OS v6.1 Edition for C++ » API Reference » B-Trees » TBtreeToken

Location: s32btree.h
Link against: estor.lib

Class TBtreeToken

TBtreeToken

Support

Supported from 5.0

Description

Encapsulates the persistent parameters for a TBtree.

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

Construction

TBtreeToken()

TBtreeToken()

Description

Default constuctor.

TBtreeToken()

TBtreeToken(TEmpty);

Description

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

Parameters

TEmpty

Intialises for an empty B-tree

[Top]

Getters and setters

IsBroken()

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.

IsEmpty()

TBool IsEmpty() const;

Description

Tests if the B-tree is empty.

Return value

TBool

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

IsIntact()

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.

Touch()

void Touch();

Description

Marks the B-tree as broken.

[Top]

Persistence

ExternalizeL()

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()

void InternalizeL(RReadStream& aStream);

Description

Internalises a TBtreeToken object from a stream.

Parameters

RReadStream& aStream

Stream from which the object should be internalised.

[Top]

Enum TEmpty

TEmpty

Description

Provides a TBtreeToken initialisation flag.

EEmpty

Initialise for an empty B-tree flag.

Copyright ©2002  Symbian Ltd.       6.1-00174

[Top]