Class TFileText

class TFileText;

Description

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

Members

Defined in TFileText:

• Read()Reads single line text record from a Unicode file into the specified descriptor
• Seek()Seeks to start or end of file
• Set()Sets the Unicode file to be read from, or written to
• TFileText()Default constructor
• Write()Writes the contents of a descriptor to the end of a Unicode file

IMPORT_C TFileText();

Description

Default constructor.

IMPORT_C void Set(RFile &aFile);

Description

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

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

Parameters

RFile &aFile The file to be used. Must be open.

IMPORT_C TInt Read(TDes &aDes);

Description

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.

Parameters

TDes &aDes On return, contains the single record read from the file. Any previous contents are overwritten.

Return value

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

IMPORT_C TInt Write(const TDesC &aDes);

Description

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.

Parameters

const TDesC &aDes The descriptor content to be appended to the file.

Return value

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

IMPORT_C TInt Seek(TSeek aMode);

Description

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.

Parameters

TSeek aMode ESeekStart to seek to the start of the file; ESeekEnd to seek to the end.

Return value

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

Panic codes

FSCLIENT 5 if aMode is neither ESeekStart nor ESeekEnd.