RShareReadStream Class Reference

#include <s32share.h>

class RShareReadStream : public RReadStream

Inherits from

Detailed Description

Supports the opening, for reading, of a stream which shares its host with other streams.

This is also called a shared read stream.

The class uses a RShareBuf stream buffer.

See also: RShareBuf RFileBuf

Constructor & Destructor Documentation

RShareReadStream ( )

RShareReadStream()[inline]

Constructs an empty shared read stream object.

Call Open() to prepare the shared stream for reading.

See also: RShareReadStream::Open()

RShareReadStream ( TStreamExchange &, TStreamPos )

IMPORT_CRShareReadStream(TStreamExchange &aHost,
TStreamPosaPos = KStreamBeginning
)

Constructs the shared read stream object and prepares the shared stream for reading.

See also: KStreamBeginning

ParameterDescription
aHostThe object that manages shared streaming.
aPosThe position of the stream within the host stream. Defaults to the beginning of the host stream, if not explicitly specified.

Member Function Documentation

Open ( TStreamExchange &, TStreamPos )

IMPORT_C voidOpen(TStreamExchange &aHost,
TStreamPosaPos =  KStreamBeginning
)

Prepares the shared stream for reading.

ParameterDescription
aHostThe object that manages shared streaming.
aPosThe position of the stream within the host stream. Defaults to the beginning of the host stream, if not explicitly specified.