Location:
S32STD.H
Link against: estor.lib
class CStreamDictionary : public CBase;
Maintains two way associations between a UID (a TUid
type) and a stream id (a TStreamId
type) .
Each UID and stream id pair forms an entry in an array. The class provides member functions to manage these entries, for example, to add a new entry or to change the stream id associated with a UID.
CBase
- Base class for all classes to be instantiated on the heap
CStreamDictionary
- Maintains two way associations between a UID (a
Defined in CStreamDictionary
:
AssignL()
, At()
, CStreamDictionary()
, ExternalizeL()
, InternalizeL()
, IsNull()
, NewL()
, NewLC()
, Remove()
, ~CStreamDictionary()
Inherited from CBase
:
Delete()
,
Extension_()
,
operator new()
static IMPORT_C CStreamDictionary *NewL();
Allocates, constructs and returns a pointer to a new stream dictionary.
The function leaves if it cannot complete successfully.
|
static IMPORT_C CStreamDictionary *NewLC();
Allocates, constructs and returns a pointer to a new stream dictionary, putting the pointer onto the cleanup stack.
Putting the pointer onto the cleanup stack allows the object and allocated resources to be cleaned up if a subsequent leave occurs.
The function leaves if it cannot complete successfully.
|
IMPORT_C ~CStreamDictionary();
Frees resources owned by the object, prior to its destruction.
IMPORT_C void AssignL(TUid aUid, TStreamId anId);
Creates or changes an association between a UID and a stream id.
If the stream dictionary already contains an entry with the same UID as aUid, then the associated stream id in that entry is replaced by anId.
If anId has the value KNullStreamId, then the function attempts to remove the entry whose unique identifier matches aUid.
|
IMPORT_C void Remove(TUid aUid);
Removes an association from the stream dictionary.
The function searches the stream dictionary for an entry whose UID matches aUid. If a match is found, the entry is removed. If no match is found, the stream dictionary remains unchanged.
|
IMPORT_C TStreamId At(TUid aUid) const;
Returns the stream id associated with the specified UID.
|
|
IMPORT_C TBool IsNull() const;
Tests whether the stream dictionary is empty.
|
IMPORT_C void ExternalizeL(RWriteStream &aStream) const;
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.
|
IMPORT_C void InternalizeL(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 this function has assignment semantics. It replaces the old value of the object with a new value read from the read stream.
|