Terminal allocation program exit XALCAID
XALCAID is driven when an automatic initiation descriptor (AID) with data is canceled either by the CEMT transaction, running a SET TERMINAL or SET CONNECTION command, or during the reinstallation of a terminal or connection.
XALCAID is invoked only if there is data associated with the AID.
- When invoked
- Whenever an AID with data is canceled. Note: It is not possible for the exit to prevent the request from being canceled.
- Exit-specific parameters
-
- UEPALTSD
- Address of a 4-byte field containing the symbolic identifier of the transaction which was to be started by this request.
- UEPALTRM
- Address of a 4-byte field containing the identifier of the terminal or connection to which this request was directed.
- UEPALDAT
- Address of an area of storage containing the data specified in the FROM
option; or hexadecimal zeros, in either of the following cases:
- The AID was created by a START request without a FROM option.
- The AID is associated with a channel (in which case the field pointed to by UEPALCHN will be set to a name other than blanks).
- UEPALLEN
- Address of a fullword binary field containing the length of the FROM data;
or hexadecimal zeros, in either of the following cases:
- The AID was created by a START request without a FROM option.
- The AID is associated with a channel (in which case the field pointed to by UEPALCHN will be set to a name other than blanks).
- UEPALRQD
- Address of an 8-byte field containing the value of the REQID associated with the FROM data. The data was stored in a temporary storage queue with this name. This value was either specified explicitly using the REQID option on the START command, or created internally by CICS®.
- UEPALQUE
- Address of an 8-byte field containing the value specified in the QUEUE option on the START command; or hexadecimal zeros if QUEUE was not specified.
- UEPALRTE
- Address of a 4-byte field containing the value specified in the RTERMID option on the START command, or hexadecimal zeros if RTERMID was not specified.
- UEPALRTA
- Address of a 4-byte field containing the value specified in the RTRANSID option on the START command, or hexadecimal zeros if RTRANSID was not specified.
- UEPALFMH
- Address of a 1-byte field containing the value X'FF' if the data contains FMHs, as specified by the FMH option on the associated START command; or hexadecimal zeros otherwise.
- UEPALSTC
- Address of a 2-byte field containing the start code. This is "SZ" for FEPI starts; otherwise it is "SD".
- UEPALCHN
- Address of a 16-byte field containing the name of the channel associated with the AID. If there is no channel associated with the AID, this field is set to blanks.
- Return codes
-
- UERCNORM
- No other return codes are supplied. The value of the return code is not inspected.
- XPI calls
- You can use:
- INQ_APPLICATION_DATA
- INQUIRE_SYSTEM
No other XPI calls should be used.
- API and SPI commands
- No EXEC CICS commands can be used.
Note: The XALTENF exit, used to handle the “terminal not known”
condition, is also invoked from the terminal allocation program. XALTENF is
described in ‘Terminal not known’ condition exits XALTENF and XICTENF.