Class ParseError

Generic input parsing error.

class ParseError( [code], [description], [extra] ) \ from Error( code, description, extra )

Inherited properties

code from Error Error code associated with this error.
description from Error Textual description for the error.
line from Error Line at which the error happened.
message from Error Arbitrary text used to better explain and define the error conditions.
module from Error Name of the module where the error has been generated.
origin from Error String identifying the origin of the error.
pc from Error Program counter of the instruction that raised the error.
subErrors from Error Array of sub-errors.
symbol from Error Symbol name (function or method) where the error has been raised.
systemError from Error If the error was caused by a failure.

Inherited methods

getSysErrDesc from Error returns system specific error description.
heading from Error Creates a short textual representation of the error.
toString from Error Creates a textual representation of the error.

Detailed description

class ParseError( [code], [description], [extra] ) \ from Error( code, description, extra )

codeA numeric error code.
descriptionA textual description of the error code.
extraA descriptive message explaining the error conditions.

Generic input parsing error.

This error is generated when a parsing operation fails. It is used by RTL and extension modules when an input that should respect a given format is malformed. In example, the core module throws this error when the command line parser is told to search for a named parameter, but the command line parameters have been exhausted.

It is also used by the mxml module to report problems while parsing XML files.

Finally, this error is available for script to describe an error status due to invalid inputs.


Made with faldoc 2.2.0