TFileText Class Reference

#include <f32file.h>

class TFileText
Public Member Functions
TFileText()
IMPORT_C TIntRead(TDes &)
IMPORT_C TIntSeek(TSeek)
IMPORT_C voidSet(RFile &)
IMPORT_C TIntWrite(const TDesC &)

Detailed Description

Reads and writes single lines of text to or from a Unicode file.

Constructor & Destructor Documentation

TFileText ( )

IMPORT_CTFileText()

Default constructor.

Member Function Documentation

Read ( TDes & )

IMPORT_C TIntRead(TDes &aDes)

Reads single line text record from a Unicode file into the specified descriptor.

The read operation begins at the current file position, and ends when a line delimiter character is read.

If the maximum length of the descriptor is insufficient to hold the record, the function returns KErrTooBig and the descriptor is filled to its maximum length.

If Read() is called when the current position is the end of the file (that is, after the last line delimiter in the file), KErrEof is returned, and the length of the buffer is set to zero.

ParameterDescription
aDesOn return, contains the single record read from the file. Any previous contents are overwritten.

Returns: KErrNone if successful, otherwise one of the other system-wide error codes.

Seek ( TSeek )

IMPORT_C TIntSeek(TSeekaMode)

Seeks to start or end of file.

It is only necessary to call this function before using Read() because Write() always seeks to the end of the file before writing.

panic
FSCLIENT 5 if aMode is neither ESeekStart nor ESeekEnd.

See also: TFileText::Read TFileText::Write

ParameterDescription
aModeESeekStart to seek to the start of the file; ESeekEnd to seek to the end.

Returns: KErrNone if successful, otherwise one of the other system-wide error codes.

Set ( RFile & )

IMPORT_C voidSet(RFile &aFile)

Sets the Unicode file to be read from, or written to.

This function must be called before Read(), Write() or Seek() can be used.

See also: TFileText::Read TFileText::Write TFileText::Seek

ParameterDescription
aFileThe file to be used. Must be open.

Write ( const TDesC & )

IMPORT_C TIntWrite(const TDesC &aDes)

Writes the contents of a descriptor to the end of a Unicode file.

A line delimiter is appended to the descriptor, and the current file position is set to the new end of file.

If the descriptor contains one or more paragraph delimiters, Read() will treat the contents of the descriptor as more than one record.

See also: TFileText::Read

ParameterDescription
aDesThe descriptor content to be appended to the file.

Returns: KErrNone if successful, otherwise one of the other system-wide error codes.