TStreamId Class Reference

class TStreamId

Provides unique identification for stream within a store.

A store always assigns a new id and constructs and returns an associated TStreamId object when a new stream is created.

RStoreWriteStream::CreateL() RStoreWriteStream::CreateLC()

Public Member Functions
TStreamId()
TStreamId(TUint32)
voidExternalizeL(RWriteStream &)
IMPORT_C voidInternalizeL(RReadStream &)
TUint32 Value()
TBool operator!=(TStreamId)
TBool operator==(TStreamId)
Private Member Functions
IMPORT_C void__DbgChkRange(TUint32)
Private Attributes
TUint32 iVal

Constructor & Destructor Documentation

TStreamId()

TStreamId()[inline]

Constructs an uninitialised object. It is necessary because there are also non-default constructors in this class.

TStreamId(TUint32)

TStreamId(TUint32aValue)[inline]

Constructs the object with the specified stream ID value.

Users of stores do not normally use this function.

In debug mode, the function checks that the supplied stream ID value is not greater than the maximum permitted value, and raises a STORE-Store 2 panic if it is. In release mode, no checking on the supplied value is done.

The checking of the supplied value is done by a private function implemented in estor. dll. This means that in debug mode, a call is made into estor.dll, but in release mode it is not.

Parameters

TUint32 aValueThe stream ID value.

Member Functions Documentation

ExternalizeL(RWriteStream &)

voidExternalizeL(RWriteStream &aStream)const [inline]

Externalises an object of this class to a write stream.

The presence of this function means that the standard templated operator<<() can be used to externalise objects of this class.

Parameters

RWriteStream & aStreamStream to which the object should be externalised.

InternalizeL(RReadStream &)

IMPORT_C voidInternalizeL(RReadStream &aStream)

Internalises an object of this class from a read stream.

The presence of this function means that the standard templated operator>>() can be used to internalise objects of this class.

Note that the function has assignment semantics. It replaces the old value of the object with a new value read from the read stream.

Parameters

RReadStream & aStreamStream from which the object should be internalised.

Value()

TUint32 Value()const [inline]

Gets the stream ID value encapsulated by this object.

__DbgChkRange(TUint32)

IMPORT_C void__DbgChkRange(TUint32aValue)[private, static]

Parameters

TUint32 aValue

operator!=(TStreamId)

TBool operator!=(TStreamIdanId)const [inline]

Inequality comparison operator. Use this operator to determine whether this stream id is unequal to the specified stream id.

Parameters

TStreamId anIdThe stream id to be compared with this stream id.

operator==(TStreamId)

TBool operator==(TStreamIdanId)const [inline]

Equality comparison operator. Use this operator to determine whether this stream id is equal to the specified stream id.

Parameters

TStreamId anIdThe stream id to be compared with this stream id.

Member Data Documentation

TUint32 iVal

TUint32 iVal[private]