Symbian
Symbian OS Library

SYMBIAN OS V9.3

[Index] [Spacer] [Previous] [Next]



Location: S32FILE.H
Link against: estor.lib

Class RFileReadStream

class RFileReadStream : public RReadStream;

Description

Supports the reading of a stream from a file.

Derivation

Members

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

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


Construction and destruction


RFileReadStream()

inline RFileReadStream();

Description

Constructs an empty read stream object.


RFileReadStream()

IMPORT_C 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

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

[Top]


Member functions


Open()

IMPORT_C 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:


Attach()

IMPORT_C 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

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