PTextFile Class Reference

#include <textfile.h>

Inheritance diagram for PTextFile:

List of all members.

Public Member Functions
Construction
	PTextFile ()
	PTextFile (OpenMode mode, int opts=ModeDefault)
	PTextFile (const PFilePath &name, OpenMode mode=ReadWrite, int opts=ModeDefault)
Line I/O functions
BOOL	ReadLine (PString &str)
BOOL	WriteLine (const PString &str)

---

Detailed Description

A class representing a a structured file that is portable accross CPU architectures. Essentially this will normalise the end of line character which differs fromplatform to platform.

---

Constructor & Destructor Documentation

PINLINE PTextFile::PTextFile (   )

Create a text file object but do not open it. It does not initially have a valid file name. However, an attempt to open the file using the PFile::Open()# function will generate a unique temporary file.

PINLINE PTextFile::PTextFile (  OpenMode  mode, int  opts = ModeDefault )

Create a unique temporary file name, and open the file in the specified mode and using the specified options. Note that opening a new, unique, temporary file name in ReadOnly mode will always fail. This would only be usefull in a mode and options that will create the file. The PChannel::IsOpen()# function may be used after object construction to determine if the file was successfully opened. Parameters: mode  Mode in which to open the file. opts  OpenOptions enum# for open operation.

PINLINE PTextFile::PTextFile (  const PFilePath &  name, OpenMode  mode = ReadWrite, int  opts = ModeDefault )

Create a text file object with the specified name and open it in the specified mode and with the specified options. The PChannel::IsOpen()# function may be used after object construction to determine if the file was successfully opened. Parameters: name  Name of file to open. mode  Mode in which to open the file. opts  OpenOptions enum# for open operation.

---

Member Function Documentation

BOOL PTextFile::ReadLine (  PString &  str  )

Read a line from the text file. What constitutes an end of line in the file is platform dependent. Use the #PChannel::GetLastError()# function to determine if there was some error other than end of file. Returns: TRUE if successful, FALSE if at end of file or a read error. Parameters: str  String into which line of text is read.

BOOL PTextFile::WriteLine (  const PString &  str  )

Read a line from the text file. What constitutes an end of line in the file is platform dependent. Use the #PChannel::GetLastError()# function to determine the failure mode. Returns: TRUE if successful, FALSE if an error occurred. Parameters: str  String to write with end of line terminator.

---

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

• textfile.h
• osutil.inl

---