DSAT gate, CHANGE_MODE function
The CHANGE_MODE function of DSAT gate is used to move a task from one CICS-managed TCB to another, or to select the mode in which the task is to run.
Input Parameters
- MODE
- specifies the mode in which the task is to run:
- CO
- concurrent mode
- FO
- file-owning mode
- QR
- quasi-reentrant mode
- RO
- resource-owning mode
- RP
- ONC/RPC-owning mode
- SZ
- secondary LU usage mode
- MODENAME
- 2-character mode name.
- MODENAME_TOKEN
- token representing modename. More efficient than using MODENAME. The token is returned by ACTIVATE_MODE and by CHANGE_MODE (see OLD_MODENAME_TOKEN)
- TCB_TOKEN
- token representing the TCB instance to which to switch. The token is returned by CHANGE_MODE (see OLD_TCB_TOKEN)
- CONDITIONAL
- Optional Parameter
- states whether the CHANGE_MODE should be conditional on the current load on the CPU.
- Values for the parameter are:
- NO
- YES
- DISASSOCIATE_TCB
- Optional Parameter
- indicates whether to disassociate the task from the TCB from which the switch is made.
- Values for the parameter are:
- NO
- YES
- FRESH_TCB
- Optional Parameter
- indicates whether a fresh TCB is required.
- Values for the parameter are:
- NO
- YES
- MATCH_STRATEGY
- Optional Parameter
- the strategy to be followed if a TCB instance that satisfies the PRIMARY_MATCH and SECONDARY_MATCH values is not found.
- Values for the parameter are:
- EXACT_THEN_NEW_THEN_BEST
- PRIMARY_MATCH
- Optional Parameter
- an 8-byte token to be used to search for a matching free TCB instance to which to switch.
- SECONDARY_MATCH
- Optional Parameter
- an 8-byte token to be used to search for a matching free TCB instance to which to switch.
Output Parameters
- REASON
- The following values are returned when RESPONSE is DISASTER:
- ACTIVATE_MODE_FAILED
- ADD_TCB_FAILED
- LOCK_FAILED
- SUSPEND_FAILED
- The following values are returned when RESPONSE is EXCEPTION:
- INSUFFICIENT_STORAGE
- MODE_NOT_ACTIVE
- NO_TCBS_ACTIVE
- NOT_OPEN_MODE_TCB
- TCB_FAILED
- TOO_FEW_TCBS
- The following values are returned when RESPONSE is INVALID:
- INVALID_FRESH_TCB_USAGE
- INVALID_MODENAME
- INVALID_MODENAME_TOKEN
- INVALID_TCB_TOKEN
- The following values are returned when RESPONSE is PURGED:
- TASK_CANCELLED
- TIMED_OUT
- RESPONSE
- Indicates whether the domain call was successful. For more information, see RESPONSE parameter on domain interfaces.
- MATCH_RESULT
- Optional Parameter
- indicates the level of success of the matching process.
- Values for the parameter are:
- EXACT_MATCH
- NO_MATCH
- NOT_APPLIC
- PRIM_NOT_SEC_MATCH
- NEW_TCB_TOKEN
- Optional Parameter
- token representing the TCB instance returned by the matching process.
- OLD_MODE
- Optional Parameter
- is the mode used by the task when the CHANGE_MODE request was issued.
- Values for the parameter are:
- CO
- FO
- QR
- RO
- RP
- SZ
- OLD_MODENAME
- Optional Parameter
- is the mode used by the task when the CHANGE_MODE request was issued. It can have the same values as OLD_MODE. OLD_MODENAME is preferred to OLD_MODE.
- OLD_MODENAME_TOKEN
- Optional Parameter
- is a token representing the mode used by the task when the CHANGE_MODE request was issued.
- OLD_TCB_TOKEN
- Optional Parameter
- is a token representing the TCB used by the task when the CHANGE_MODE request was issued.