Layout of a Condition Token

Edit online

Figure 1 displays a map of the condition token. The starting bit position is shown for each field.

Figure 1. ILE Condition Token Layout
Condition Token Layout
Every condition token contains the components indicated in Figure 1:
Condition_ID
A 4-byte identifier that, with the Facility_ID, describes the condition that the token communicates. ILE bindable APIs and most applications produce case 1 conditions.
Case
A 2-bit field that defines the format of the Condition_ID portion of the token. ILE conditions are always case 1.
Severity
A 3-bit binary integer that indicates the severity of the condition. The Severity and MsgSev fields contain the same information. See Table 1 for a list of ILE condition severities. See Table 1 and Table 2 for the corresponding operating system message severities.
Control
A 3-bit field containing flags that describe or control various aspects of condition handling. The third bit specifies whether the Facility_ID has been assigned by IBM®.
Facility_ID
A 3-character alphanumeric string that identifies the facility that generated the condition. The Facility_ID indicates whether the message was generated by the system or an HLL runtime. Table 1 lists the facility IDs used in ILE.
I_S_Info
A 4-byte field that identifies the instance specific information associated with a given instance of the condition. This field contains the reference key to the instance of the message associated with the condition token. If the message reference key is zero, there is no associated message.
MsgSev
A 2-byte binary integer that indicates the severity of the condition. MsgSev and Severity contain the same information. See Table 1 for a list of ILE condition severities. See Table 1 and Table 2 for the corresponding operating system message severities.
MsgNo
A 2-byte binary number that identifies the message associated with the condition. The combination of Facility_ID and MsgNo uniquely identifies a condition.
Table 1 contains the facility IDs used in ILE condition tokens and in the prefix of messages.
Table 1. Facility IDs Used in Messages and ILE Condition Tokens
Facility ID Facility
CEE ILE common library
CPF IBM i message
MCH IBM i machine exception message