Symbian Developer Library

SYMBIAN OS V6.1 EDITION FOR C++

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



Location: s32file.h
Link against: estor.lib

Class RFileReadStream

RFileReadStream

Support

Supported from 5.0

Description

Supports the reading of a stream from a file.

Derivation

RFileReadStreamSupports the reading of a stream from a file
RReadStreamThe read stream interface

Defined in RFileReadStream:
Attach(), Open(), RFileReadStream()

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


Allocation and construction


RFileReadStream()

RFileReadStream()

Description

Constructs an empty read stream object.


RFileReadStream()

RFileReadStream(RFile& aFile,TInt aPos=0);

Description

Constructs the read stream object, associates it with an already opened file, and prepares the stream for reading.

Parameters

RFile& aFile

A reference to the opened file.

TInt aPos=0

The offset into the file from where the stream is to be read. Defaults to zero.


Attach()

void Attach(RFile& aFile,TInt aPos=0);

Description

Associates this stream with an already opened file and prepares the stream for reading.

Parameters

RFile& aFile

A reference to the opened file.

TInt aPos=0

The offset into the file from where the stream is to be read. Defaults to zero.


Open()

TInt Open(RFs& aFs,const TDesC& aName,TUint aFileMode);

Description

Opens a file containing a stream and prepares the stream for reading.

The stream will be read from offset zero in the file.

Parameters

RFs& aFs

Handle to a file server session.

const TDesC& aName

The full path name of the file.

TUint aFileMode

The mode in which the file is to be accessed. The mode is defined by by the TFileMode type.

Return value

TInt

KErrNone, if successful; otherwise, one of the other system wide eror codes.

See also: