Symbian Developer Library

SYMBIAN OS V6.1 EDITION FOR C++

[Index] [Glossary] [Previous] [Next]



Location: msvstore.h
Link against: msgs.lib

Class RMsvReadStream

RMsvReadStream

Support

Supported from 5.0

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.

Derivation

RMsvReadStreamAccesses the streams in a message store with read access
RReadStreamThe read stream interface

Defined in RMsvReadStream:
OpenL(), OpenLC()

Inherited from RReadStream:
Attach(), Close(), Detach(), Pop(), PushL(), ReadInt16L(), ReadInt32L(), ReadInt8L(), ReadL(), ReadReal32L(), ReadReal64L(), ReadUint16L(), ReadUint32L(), ReadUint8L(), Release(), Source()


Prepare stream for reading


OpenL()

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

Description

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

const CMsvStore& aMsvStore

The CMsvStore the stream is in.

TUid aUid

The UID of the stream to open with read access

Leave codes

KErrNotFound

There is no stream with UID aUid

Other

Standard stream leave codes.


OpenLC()

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

Description

Prepares an existing stream with UID for reading and places it on the cleanup stack.

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

Parameters

const CMsvStore& aMsvStore

The CMsvStore the stream is in.

TUid aUid

The UID of the stream to open with read access

Leave codes

KErrNotFound

There is no stream with UID aUid

Other

Standard stream leave codes.