api:throw

Version 22.0.8500


api:throw

Version 22.0.8500


The api:throw keyword is used to raise an error (exception) from within a script.

Parameters

  • code: A string value used to identify the source or meaning of the exception. This parameter is required.
  • desc[ription]: An optional parameter that specifies a short message describing the error condition.
  • details: An optional parameter that can specify additional data useful to diagnose the error condition.

Control Attributes

None

Example

The example below explicitly defines both the error code and description:

<api:throw code="myerror" desc="thedescription" />

See Also

  • api:try: Define a scope for catching exceptions.
  • api:catch: Catch thrown exceptions and define exception processing.