TFileText Class Reference

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

#include <f32file.h>

Public Member Functions
IMPORT_C	TFileText ()
	Default constructor.
IMPORT_C void	Set (RFile &aFile)
	Sets the Unicode file to be read from, or written to.
IMPORT_C TInt	Read (TDes &aDes)
	Reads single line text record from a Unicode file into the specified descriptor.
IMPORT_C TInt	Write (const TDesC &aDes)
	Writes the contents of a descriptor to the end of a Unicode file.
IMPORT_C TInt	Seek (TSeek aMode)
	Seeks to start or end of file.

Detailed Description

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

API status

Published to all clients. Released API.

Definition at line 3357 of file f32file.h.

Constructor & Destructor Documentation

TFileText()

IMPORT_C TFileText::TFileText

(

)

Default constructor.

(generated from Symbian Developer Library)

Member Function Documentation

Read()

IMPORT_C TInt TFileText::Read

(

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.

Parameters

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

(generated from Symbian Developer Library)

Seek()

IMPORT_C TInt TFileText::Seek

(

TSeek

aMode

)

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

aMode

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

Panic condition: FSCLIENT 5 if aMode is neither ESeekStart nor ESeekEnd.

(generated from Symbian Developer Library)

Set()

IMPORT_C void TFileText::Set

(

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.

TFileText::Read TFileText::Write TFileText::Seek

Parameters

aFile

The file to be used. Must be open.

(generated from Symbian Developer Library)

Write()

IMPORT_C TInt TFileText::Write

(

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.

TFileText::Read

Parameters

aDes	The descriptor content to be appended to the file.

(generated from Symbian Developer Library)

---

The documentation for this class was generated from the following files:

• f32file.h
• f32file.h.dox