EPOC   SDK Home Glossary Indexes Previous Next Up

RMsvReadStream class


Contents


RMsvReadStream class — Stream read

Section Contents


Overview

Compatibility

Applications that use this class will not work correctly on a version of EPOC earlier than ER5.

Derivation

RReadStream

Abstract: supports read and internalise operations

RDictionaryReadStream

Supports creation and manipulation of a stream in a dictionary store

Defined in

msvstore.h

Link against

ment.lib

Description

This class is used to access 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 RDictionaryReadStream and RReadStream.


Prepare stream for reading


OpenL() — Open a stream for reading

void OpenL(const CMsvStore& aMsvStore, TUid aUid);

Description

Use this function to prepare an existing stream with UID aUid in the store aMsvStore for reading. After this function has been called, the stream can be read from with the functions provided by the RReadStream base class.

Arguments

const CMsvStore& aMsvStore

The CMsvStore the stream is in.

TUid aUid

The UID of the stream to open with read access

Leave considerations

KErrNotFound

There is no stream with UID aUid

Other

Standard stream leave codes


OpenLC() — Open a stream for reading and place on cleanup stack

void OpenLC(const CMsvStore& aMsvStore, TUid aUid);

Description

Use this function to prepare an existing stream with UID aUid in the store aMsvStore for reading. After this function has been called, the stream can be read from with the functions provided by the RReadStream base class.

OpenLC() places the stream on the cleanup stack.

Arguments

const CMsvStore& aMsvStore

The CMsvStore the stream is in.

TUid aUid

The UID of the stream to open with read access

Leave considerations

KErrNotFound

There is no stream with UID aUid

Other

Standard stream leave codes

EPOC       SDK Home Glossary Indexes Previous Next Up