PGRE gate, PREPARE_RETURN_EXEC function
The PREPARE_RETURN_EXEC function of the PGRE gate is used to process the communications area, inputmsg data, and transaction identifier from a user EXEC CICS RETURN command.
Input Parameters
- CHANNEL
- Optional Parameter
- is the optional channel to be made available to the linked program.
- COMMAREA
- Optional Parameter
- is the optional communications area to be made available to the linked program.
- ENDACTIVITY
- Optional Parameter
- indicates that a BTS activity is to be ended.
- Values for the parameter are:
- YES
- IMMEDIATE
- Optional Parameter
- Indicates whether or not the transaction specified in TRANSID is to be attached as the next transaction regardless of any other transactions enqueued by ATI for this terminal.
- Values for the parameter are:
- YES
- INPUTMSG
- Optional Parameter
- is a data area to be supplied to the linked program on its first execution of an EXEC CICS RECEIVE command.
- TRANSID
- Optional Parameter
- is the four-character transaction identifier.
Output Parameters
- REASON
- The following values are returned when RESPONSE is EXCEPTION:
- INVALID_CHANNEL_NAME
- INVALID_COMMAREA_ADDR
- INVALID_COMMAREA_LEN
- INVALID_INPUTMSG_LEN
- INVALID_KEYWORDS
- INVALID_REQUEST_FROM_EXIT
- INVALID_RETURN_REQUEST
- INVALID_TERMINAL_TYPE
- NO_TERMINAL
- NOT_INITIALIZED
- TRANSID_NO_TERMINAL
- RESPONSE
- Indicates whether the domain call was successful. For more information, see RESPONSE parameter on domain interfaces.