Product SiteDocumentation Site

11.3.5. Condition Objects

A condition object is a directory returned by the Object option of the CONDITION built-in function. This directory contains all information currently available on a trapped condition. The information varies with the trapped condition. The Nil object is returned for any entry not available to the condition. The following entries can be found in a condition object:
ADDITIONAL
The additional information object associated with the condition. This is the same object that the Additional option of the CONDITION built-in function returns. The ADDITIONAL information may be specified with the ADDITIONAL or ARRAY options of the RAISE instruction.
DESCRIPTION
The string describing the condition. The Description option of the CONDITION built-in function also returns this value.
INSTRUCTION
The keyword for the instruction executed when the condition was trapped, either CALL or SIGNAL. The Instruction option of the CONDITION built-in function also returns this value.
CONDITION
The name of the trapped condition. The Condition name option of the CONDITION built-in function also returns this value.
RESULT
Any result specified on the RETURN or EXIT options of a RAISE instruction.
RC
The major Rexx error number for a SYNTAX condition. This is the same error number assigned to the special variable RC.
CODE
The detailed identification of the error that caused a SYNTAX condition. This number is a nonnegative number in the form nn.nnn. The integer portion is the Rexx major error number (the same value as the RC entry). The fractional portion is a subcode that gives a precise indication of the error that occurred.
ERRORTEXT
The primary error message for a SYNTAX condition. This is the same message available from the ERRORTEXT built-in function.
MESSAGE
The secondary error message for a SYNTAX condition. The message also contains the content of the ADDITIONAL information.
PACKAGE
The Package object associated with the program where a condition was raised.
POSITION
The line number in source code at which a condition was raised.
PROGRAM
The name of the program where a condition was raised.
STACKFRAMES
A single-index list of StackFrame instances (see Section 5.4.21, “The StackFrame Class”).
TRACEBACK
A single-index list of formatted traceback lines.
PROPAGATED
The value 0 (false) if the condition was raised at the same level as the condition trap or the value 1 (true) if the condition was reraised with RAISE PROPAGATE.