Class TStreamId

class TStreamId;

Description

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.

Members

Defined in TStreamId:

• ExternalizeL(RWriteStream &)constExternalises an object of this class to a write stream.
• InternalizeL(RReadStream &)Internalises an object of this class from a read stream.
• TStreamId()Constructs an uninitialised object. It is necessary because there are also non-d...
• TStreamId(TUint32)Constructs the object with the specified stream ID value.
• Value()constGets the stream ID value encapsulated by this object.
• operator!=(TStreamId)constInequality comparison operator. Use this operator to determine whether this stre...
• operator==(TStreamId)constEquality comparison operator. Use this operator to determine whether this stream...

See also:

• RStoreWriteStream::CreateL(CStreamStore &)Creates a new stream.
• RStoreWriteStream::CreateLC(CStreamStore &)Creates a new stream, putting a cleanup item onto the cleanup stack.

inline TStreamId();

Description

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

inline TStreamId(TUint32 aValue);

Description

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 aValue The stream ID value.

inline TBool operator==(TStreamId anId) const;

Description

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

Parameters

TStreamId anId The stream id to be compared with this stream id.

Return value

TBool True, if the stream ids are equal; false otherwise

inline TBool operator!=(TStreamId anId) const;

Description

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

Parameters

TStreamId anId The stream id to be compared with this stream id.

Return value

TBool True, if the two stream ids are unequal, false otherwise.

inline void ExternalizeL(RWriteStream &aStream) const;

Description

Externalises an object of this class to a write stream.

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

Parameters

RWriteStream &aStream Stream to which the object should be externalised.

IMPORT_C void InternalizeL(RReadStream &aStream);

Description

Internalises an object of this class from a read stream.

The presence of this function means that the standard templated operator>>(RReadStream &,T &) 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 &aStream Stream from which the object should be internalised.

inline TUint32 Value() const;

Description

Gets the stream ID value encapsulated by this object.

Return value

TUint32 The stream ID value.