Function: error_exception

Syntax

error_exception (<text>, <code> {,<severity>})

Type

exception

Returns

A new user exception with details of a user error.

Parameters

• <text>
  The text of the error, a string value.

• <code>
  The code of the error, a numeric value. Error codes with a value greater than 1000 are reserved for system errors, so this should be in the range 1 through 999.

• <severity>
  The severity of the error, a numeric value in the range 1 through 10. If omitted, the value 1 is assumed. Via the system numeric throw_level, try/catch blocks can be restricted to processing only exceptions below a particular severity. The most serious errors have the lowest severity value.

Notes

There are 3 styles of exception: error, warning and interrupt. They behave identically and are differentiated only by style for user-analysis purposes.

The exception is initialized with a full command frame stack trace to aid with debugging.

Examples

Throw a user error.

throw error_exception('Invalid file',556)

See Also