RMsvReadStream Class Reference

#include <mw/msvstore.h>

class RMsvReadStream : public RReadStream, public RReadStream

Inherits from

Detailed Description

Accesses the streams in a message store with read access.

Before it is used, a CMsvStore must have been opened on the message store with read or read/write access.

This class is intended for use by MTM implementations to store MTM-specific information. Message client applications access the store through the higher-level functions provided by Client-side and User Interface MTMs.

Most of its functionality is provided by the base class RReadStream.

Member Function Documentation

OpenL ( const CMsvStore &, TUid )

IMPORT_C voidOpenL(const CMsvStore &aMsvStore,
TUidaUid
)

Prepares an existing stream with UID for reading.

After this function has been called, the stream can be read from with the functions provided by the RReadStream base class.

Parameters
aMsvStoreThe CMsvStore the stream is in.
aUidThe UID of the stream to open with read access
Leave Codes
KErrNotFoundThere is no stream with UID aUid
OtherStandard stream leave codes.

OpenLC ( const CMsvStore &, TUid )

IMPORT_C voidOpenLC(const CMsvStore &aMsvStore,
TUidaUid
)

Prepares an existing stream with UID for reading.

After this function has been called, the stream can be read from with the functions provided by the RReadStream base class.

The object is placed on the cleanup stack.

Parameters
aMsvStoreThe CMsvStore the stream is in.
aUidThe UID of the stream to open with read access
Leave Codes
KErrNotFoundThere is no stream with UID aUid
OtherStandard stream leave codes.

OpenLC ( CMsvCachedStore &, TUid )

voidOpenLC(CMsvCachedStore &aStore,
TUidaUid
)

The RMsvReadStream::OpenLC method

ties the read stream to a HMsvReadBuf

Parameters
aStoreaStore is the CMsvCachedStore within which we look for the stream
aUidid of stream to open for reading
Leave Codes
leavesif we can't find the stream