Class file_reader

The is a simple class to read a line from a file. This class also recognized and will handle '#include' files.

Build Information

Author Fred McGuirk
Date Feb 23, 2007
Outputfile file_reader.pvc
Forcelinenumbers false

Constructor

Open the specified file for reading and start a counter to keep track of the number of INLCUDE files that are referenced. The [ProvideX Class:path_resolver] object will be used to expand the name of the INCLUDE file.

ParameterDescription
inFile$ The name of file to read
inPathResolver A reference to a [ProvideX Class:path_resolver] class to expand the name of include files.

Properties

PROPERTY _version$

PROPERTY aTracker

Type Reference to [ProvideX Class:obj_tracker]

Methods

FUNCTION getEOF()

Get the end of file status

Returns A boolean that is set to TRUE (1) when end of data stream has been reached.
FUNCTION read$()

Read a line of text from the file.

Returns A string containing the text that was retrieved
FUNCTION setIgnoreIncludes(inBoolean)

Set a flag to disable processing of '#include' references

ParameterDescription
inBoolean (0=False, 1=True)