RDictionaryWriteStream Class Reference

#include <s32stor.h>

class RDictionaryWriteStream : public RWriteStream

Inherits from

Detailed Description

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

See also: CDictionaryStore

Constructor & Destructor Documentation

RDictionaryWriteStream ( )

RDictionaryWriteStream()[inline]

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

RDictionaryWriteStream ( const MExternalizer< TStreamRef > & )

RDictionaryWriteStream(const MExternalizer< TStreamRef > &anExter)[inline]

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

See also: CStoreMap

ParameterDescription
anExterSpecifies an externaliser.

Member Function Documentation

AssignL ( CDictionaryStore &, TUid )

IMPORT_C voidAssignL(CDictionaryStore &aDictStore,
TUidaUid
)

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.

See also: RWriteStream::Release()

ParameterDescription
aDictStoreThe dictionary store which contains the new or replacement stream.
aUidThe UID associated with the stream.

AssignLC ( CDictionaryStore &, TUid )

IMPORT_C voidAssignLC(CDictionaryStore &aDictStore,
TUidaUid
)

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.

ParameterDescription
aDictStoreThe dictionary store which contains the new or replacement stream.
aUidThe UID associated with the stream.