Collapse all Symbian^3 Product Developer Library

TFileText Class Reference

class TFileText

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

Public Member Functions
	TFileText()
IMPORT_C TInt	Read(TDes &)
IMPORT_C TInt	Seek(TSeek)
IMPORT_C void	Set(RFile &)
IMPORT_C TInt	Write(const TDesC &)

Private Member Functions
TInt	CheckForTerminator(TBool &)
TInt	FillBuffer()
void	NextRecord()

Private Member Enumerations
enum	TFileState { EStartOfFile, ENormal, EReverse }

Private Attributes
const TText *	iEnd
RFile	iFile
const TText *	iNext
TBuf8< 0x100 >	iReadBuf
TFileState	iState

Constructor & Destructor Documentation

TFileText()

IMPORT_C

TFileText

(

)

Default constructor.

Member Functions Documentation

CheckForTerminator(TBool &)

TInt

CheckForTerminator

(

TBool &

anAnswer

)

[private]

Parameters

TBool & anAnswer

FillBuffer()

TInt

FillBuffer

(

)

[private]

NextRecord()

void

NextRecord

(

)

[private]

Read(TDes &)

IMPORT_C TInt

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

TDes & aDes

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

Seek(TSeek)

IMPORT_C TInt

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.

panic: FSCLIENT 5 if aMode is neither ESeekStart nor ESeekEnd.

TFileText::Read TFileText::Write

Parameters

TSeek aMode

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

Set(RFile &)

IMPORT_C void

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

RFile & aFile

The file to be used. Must be open.

Write(const TDesC &)

IMPORT_C TInt

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

const TDesC & aDes

The descriptor content to be appended to the file.

Member Enumerations Documentation

Enum TFileState

Enumerators

EStartOfFile
ENormal
EReverse

Member Data Documentation

const TText * iEnd

const TText *

iEnd

[private]

RFile iFile

RFile

iFile

[private]

const TText * iNext

const TText *

iNext

[private]

TBuf8< 0x100 > iReadBuf

TBuf8< 0x100 >

iReadBuf

[private]

TFileState iState

TFileState

iState

[private]