A class representing a a structured file that is portable accross CPU architectures.
Inheritance:
Public Methods
| Construction
|
| Line I/O functions
|
Inherited from PFile:
Public Methods
-
Overrides from class PObject
-
Overrides from class PChannel
-
File manipulation functions
-
File channel functions
Protected Fields
-
PFilePath path
-
BOOL removeOnClose
Public Methods
-
Information functions
-
Reading functions
-
Writing functions
-
Miscellaneous functions
-
static BOOL ConvertOSError( int libcReturnValue, Errors & lastError, int & osError )
Public Members
-
Error functions
Protected Fields
-
int os_handle
-
Errors lastErrorCode[NumErrorGroups+1]
-
int lastErrorNumber[NumErrorGroups+1]
-
PINDEX lastReadCount
-
PINDEX lastWriteCount
-
PTimeInterval readTimeout
-
PTimeInterval writeTimeout
Protected Methods
-
virtual BOOL ConvertOSError( int libcReturnValue, ErrorGroup group = LastGeneralError )
-
BOOL SetErrorValues( Errors errorCode, int osError, ErrorGroup group = LastGeneralError )
-
int ReadCharWithTimeout( PTimeInterval & timeout )
Inherited from PObject:
Public Methods
-
Run Time Type functions
-
I/O functions
Public Members
-
Comparison functions
Documentation
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.
Construction
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.
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.
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.
Line I/O functions
BOOL 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.
- Parameters:
- - str String into which line of text is read.
- Returns:
- TRUE if successful, FALSE if at end of file or a read error.
BOOL 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.
- Parameters:
- - str String to write with end of line terminator.
- Returns:
- TRUE if successful, FALSE if an error occurred.
- This class has no child classes.
Alphabetic index HTML hierarchy of classes or Java
This page was generated with the help of DOC++.