Class RDictionaryWriteStream

class RDictionaryWriteStream : public RWriteStream;

Description

Supports the creation or replacement of a stream a dictionary store.

Derivation

• RWriteStream - ...

• RDictionaryWriteStream - Supports the creation or replacement of a stream a dictionary store.

Members

Defined in RDictionaryWriteStream:

• AssignL(CDictionaryStore &,TUid)Prepares a stream in the specified dictionary store for writing.
• AssignLC(CDictionaryStore &,TUid)Prepares a stream in the specified dictionary store for writing, and places a cl...
• RDictionaryWriteStream()Constructs an uninitialised object. It is necessary because there are also non-d...
• RDictionaryWriteStream(const MExternalizer< TStreamRef > &)Constructs the object with an externaliser. The store map CStoreMap is an exampl...

Inherited from RWriteStream:

• Attach(MStreamBuf *)Sets the stream buffer sink for this write stream. The existing sink, if there i...
• Close()Commits data to the stream before freeing resources used by the stream. This ens...
• CommitL()Ensures that any buffered data is written to the stream. Once committed, it is n...
• Detach()Sets the stream buffer sink for this write stream to NULL. The existing sink, if...
• Pop()Removes the cleanup item for this write stream object from the cleanup stack.
• PushL()Puts a cleanup item for this write stream object onto the cleanup stack. This al...
• RWriteStream(MStreamBuf *)Constructs a write stream over the supplied stream buffer. The stream has no ass...
• RWriteStream(const MExternalizer< TStreamRef > &)Constructs a write stream with an associated store map. The stream buffer sink i...
• Release()Frees resources before abandoning the stream. The function is called after data ...
• Sink()Gets the underlying stream buffer for the write stream. This provides access to ...
• WriteInt16L(TInt)Writes a TInt value as a 16 bit value to this stream.
• WriteInt32L(TInt32)Writes a TInt32 value as a 32 bit value to this stream.
• WriteInt8L(TInt)Writes a TInt value as an 8 bit value to this stream.
• WriteL(RReadStream &)Writes the content of the specified read stream to this write stream.
• WriteL(RReadStream &,TInt)Writes data of the specified length from the specified read stream to this strea...
• WriteL(const TDesC16 &)Writes the content of the 16 bit descriptor to the stream. No other information ...
• WriteL(const TDesC16 &,TInt)Writes data of the specified length from the 16 bit descriptor to the stream. No...
• WriteL(const TDesC8 &)Writes the content of the 8 bit descriptor to the stream. No other information i...
• WriteL(const TDesC8 &,TInt)Writes data of the specified length from the 8 bit descriptor to the stream. No ...
• WriteL(const TUint16 *,TInt)Writes 16 bit data of the specified length from the specified location to this w...
• WriteL(const TUint8 *,TInt)Writes 8 bit data of the specified length from the specified location to this wr...
• WriteReal32L(TReal)Writes a TReal value as a 32 bit value to this stream.
• WriteReal64L(TReal64)Writes a TReal64 value as a 64 bit value to this stream.
• WriteUint16L(TUint)Writes a TUint value as a 16 bit value to this stream.
• WriteUint32L(TUint32)Writes a TUint32 value as a 32 bit value to this stream.
• WriteUint8L(TUint)Writes a TUint value as an 8 bit value to this stream.

inline RDictionaryWriteStream();

Description

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

inline RDictionaryWriteStream(const MExternalizer< TStreamRef > &anExter);

Description

Constructs the object with an externaliser. The store map CStoreMap is an example of an externaliser.

Parameters

const MExternalizer< TStreamRef > &anExter Specifies an externaliser.

IMPORT_C void AssignL(CDictionaryStore &aDictStore, TUid aUid);

Description

Prepares a stream in the specified dictionary store for writing.

If no stream is associated with the specified UID, then a new stream is created and an association is made between the resulting stream id and the specified UID. If a stream is currently associated with the specified UID, then this existing stream is prepared for replacement.

Parameters

CDictionaryStore &aDictStore The dictionary store which contains the new or replacement stream. TUid aUid The UID associated with the stream.

See also:

• RWriteStream::Release()Frees resources before abandoning the stream. The function is called after data ...

IMPORT_C void AssignLC(CDictionaryStore &aDictStore, TUid aUid);

Description

Prepares a stream in the specified dictionary store for writing, and places a cleanup item for this RDictionaryWriteStream object onto the cleanup stack.

If no stream is associated with the specified UID, then a new stream is created and an association is made between the resulting stream id and the specified UID. If a stream is currently associated with the specified UID, then this existing stream is prepared for replacement.

Placing a cleanup item onto the cleanup stack allows allocated resources to be cleaned up if a subsequent leave occurs.

Parameters

CDictionaryStore &aDictStore The dictionary store which contains the new or replacement stream. TUid aUid The UID associated with the stream.