Class ParamError

Incongruent paremeter error.

class ParamError( [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 code of this 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 during an OS operation, this this property contains the error code indicating the cause of the 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

Incongruent paremeter error.

This error is generated when a function is called with insufficient parameters, or with parameters of the wrong types; this error may also be raised if the function determines the parameters not to be valid for other reasons (i.e. if the function requires not just a string as a parameter, but also a string of a minimum length).

This error usually indicates a problem in the script code. Normally, it is to be considered a runtime error that has to be resolved by fixing an incorrect script, which should pass correct parameter to the functions it calls.


Made with faldoc 2.1.0