Symbian Developer Library

SYMBIAN OS V6.1 EDITION FOR C++

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



Location: s32std.h
Link against: estor.lib

Class TStreamId

TStreamId

Support

Supported from 5.0

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.

Defined in TStreamId:
ExternalizeL(), InternalizeL(), TStreamId(), operator!=(), operator==()

See also:


Construction and destruction


TStreamId()

TStreamId();

Description

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

[Top]


Stream persistence


ExternalizeL()

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<<() can be used to externalise objects of this class.

Parameters

RWriteStream& aStream

Stream to which the object should be externalised.


InternalizeL()

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

[Top]


Comparison operators


operator==()

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


operator!=()

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.