PGXE gate, PREPARE_XCTL_EXEC function
The PREPARE_XCTL_EXEC function of the PGXE gate processes the communications area, inputmsg data, and transaction identifier from a user EXEC CICS XCTL command.
Input Parameters
- PROGRAM_NAME
- The name of the program resource to be defined.
- CHANNEL
- Optional Parameter
- The optional channel to be made available to the linked program.
- COMMAREA
- Optional Parameter
- The optional communications area to be made available to the linked program.
- INPUTMSG
- Optional Parameter
- A data area to be supplied to the linked program on its first execution of an EXEC CICS RECEIVE command.
- SECURITY
- Optional Parameter
- Indicates whether Program Manager must check security authorization for the target program
- Values for the parameter are:
- NO
- YES
- SYSEIB_REQUEST
- Optional Parameter
- Specifies whether the EXEC CICS LINK had the SYSEIB translator option specified.
- Values for the parameter are:
- NO
- YES
Output Parameters
- REASON
- The following values are returned when RESPONSE is EXCEPTION:
- AUTOINSTALL_FAILED
- AUTOINSTALL_INVALID_DATA
- AUTOINSTALL_MODEL_NOT_DEF
- AUTOINSTALL_URM_FAILED
- DESTRUCTIVE_OVERLAP
- INVALID_CHANNEL_NAME
- INVALID_COMMAREA_ADDR
- INVALID_COMMAREA_LEN
- INVALID_INPUTMSG_LEN
- INVALID_KEYWORDS
- INVALID_REQUEST_FROM_EXIT
- INVALID_TERMINAL_TYPE
- NO_TERMINAL
- NOT_INITIALIZED
- PROGRAM_NOT_AUTHORISED
- PROGRAM_NOT_DEFINED
- PROGRAM_NOT_ENABLED
- PROGRAM_NOT_LOADABLE
- REMOTE_PROGRAM
- TRANSACTION_ABEND
- ABEND_CODE
- The four-character abend code to be issued if CICS drives the system default, which is to abend the transaction.
- RESPONSE
- Indicates whether the domain call was successful. For more information, see RESPONSE parameter on domain interfaces.