TStorePagePoolToken Class Reference

#include <s32stor.h>

class TStorePagePoolToken
Public Member Enumerations
enumTEmpty { EEmpty }
Public Member Functions
TStorePagePoolToken()
TStorePagePoolToken(TEmpty)
IMPORT_C voidExternalizeL(RWriteStream &)
TBool HasAvailable()
IMPORT_C voidInternalizeL(RReadStream &)
TBool IsEmpty()
voidTouch()

Detailed Description

Persistent settings to use for a RStorePagePool.

See also: RStorePagePool

Member Enumeration Documentation

Enum TEmpty

Provides a TStorePagePoolToken initialisation flag. Initialise for an empty page pool flag.

EnumeratorValueDescription
EEmpty

Constructor & Destructor Documentation

TStorePagePoolToken ( )

TStorePagePoolToken()[inline]

Default constructor.

TStorePagePoolToken ( TEmpty )

TStorePagePoolToken(TEmpty)[inline]

Constructor that intialises the TStorePagePoolToken for an empty page pool.

Member Function Documentation

ExternalizeL ( RWriteStream & )

IMPORT_C voidExternalizeL(RWriteStream &aStream)const

Externalises a TStorePagePoolToken object to a stream.

ParameterDescription
aStreamStream to which the object should be externalised

HasAvailable ( )

TBool HasAvailable()const [inline]

Tests if there is a free page in the pool.

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

InternalizeL ( RReadStream & )

IMPORT_C voidInternalizeL(RReadStream &aStream)

Internalises a TStorePagePoolToken object from a stream.

ParameterDescription
aStreamStream from which the object should be internalised

IsEmpty ( )

TBool IsEmpty()const [inline]

Tests if the page pool is empty.

Returns: True if the page pool is empty, otherwise false.

Touch ( )

voidTouch()[inline]

Sets the available pages to 0.