#include <s32std.h>
| class CStreamDictionary : public CBase |
| Public Member Functions | |
|---|---|
| CStreamDictionary() | |
| ~CStreamDictionary() | |
| IMPORT_C void | AssignL(TUid, TStreamId) |
| IMPORT_C TStreamId | At(TUid) |
| IMPORT_C void | ExternalizeL(RWriteStream &) |
| IMPORT_C void | InternalizeL(RReadStream &) |
| IMPORT_C TBool | IsNull() |
| IMPORT_C CStreamDictionary * | NewL() |
| IMPORT_C CStreamDictionary * | NewLC() |
| IMPORT_C void | Remove(TUid) |
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.
See also: TUid TStreamId CDictionaryStore
| IMPORT_C | ~CStreamDictionary | ( | ) |
Frees resources owned by the object, prior to its destruction.
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.
See also: CStreamDictionary::Remove()
| Parameter | Description |
|---|---|
| aUid | The UID |
| anId | The stream id. |
Returns the stream id associated with the specified UID.
| Parameter | Description |
|---|---|
| aUid | The UID whose associated stream id is to be returned. |
Returns: The stream id associated with the specified UID.KNullStreamId, if no entry in the stream dictionary contains the specified UID.
| 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.
| Parameter | Description |
|---|---|
| aStream | Stream to which the object should be externalised |
| 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.
| Parameter | Description |
|---|---|
| aStream | Stream from which the object should be internalised. |
| IMPORT_C TBool | IsNull | ( | ) | const |
Tests whether the stream dictionary is empty.
Returns: True, if the stream dictionary is empty. False if the stream dictionary contains at least one entry.
| IMPORT_C CStreamDictionary * | NewL | ( | ) | [static] |
Allocates, constructs and returns a pointer to a new stream dictionary.
The function leaves if it cannot complete successfully.
Returns: A pointer to the new stream dictionary object.
| IMPORT_C CStreamDictionary * | NewLC | ( | ) | [static] |
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.
Returns: A pointer to the new stream dictionary object.
| 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.
| Parameter | Description |
|---|---|
| aUid | The UID whose matching entry is to be removed from the stream dictionary. |