Symbian Developer Library

SYMBIAN OS V6.1 EDITION FOR C++

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



Location: sb32tree.h
Link against: estor.lib

Class TStorePagePoolToken

TStorePagePoolToken

Support

Supported from 5.0

Description

Persistent settings to use for a RStorePagePool.

Defined in TStorePagePoolToken:
EEmpty, ExternalizeL(), HasAvailable(), InternalizeL(), IsEmpty(), TEmpty, TStorePagePoolToken(), Touch()

See also:


Construction


TStorePagePoolToken()

TStorePagePoolToken();

Description

Default constructor.


TStorePagePoolToken()

TStorePagePoolToken(TEmpty);

Description

Constructor that intialises the TStorePagePoolToken for an empty page pool.

Parameters

TEmpty

Intialises for an empty page pool

[Top]


Getters and setters


HasAvailable()

TBool HasAvailable() const;

Description

Tests if there is a free page in the pool.

Return value

TBool

True if there is a free page in the pool, otherwise false


IsEmpty()

TBool IsEmpty() const;

Description

Tests if the page pool is empty.

Return value

TBool

True if the page pool is empty, otherwise false.


Touch()

void Touch();

Description

Sets the available pages to 0.

[Top]


Persistence


ExternalizeL()

void ExternalizeL(RWriteStream& aStream) const;

Description

Externalises a TStorePagePoolToken object to a stream.

Parameters

RWriteStream& aStream

Stream to which the object should be externalised


InternalizeL()

void InternalizeL(RReadStream& aStream);

Description

Internalises a TStorePagePoolToken object from a stream.

Parameters

RReadStream& aStream

Stream from which the object should be internalised

[Top]


Enum TEmpty

TEmpty

Description

Provides a TStorePagePoolToken initialisation flag.

EEmpty

Initialise for an empty page pool flag.