z/OS JES2 Macros
Previous topic | Next topic | Contents | Contact z/OS | Library | PDF


$EXIT – Provide exit point

z/OS JES2 Macros
SA32-0996-00

Use $EXIT to establish an exit point in an assembly module. The assembly environment active at the time of the $EXIT invocation determines the exit effector that JES2 will use and the execution environment that JES2 assumes for the exit routines it will call.

Format description

Read syntax diagramSkip visual syntax diagram
>>-+--------+--$EXIT--exitid-code------------------------------->
   '-symbol-'                       

>--+-----------------------------+------------------------------>
   '-,JOBMASK--=--+-(--R--n--)-+-'   
                  '-relexp-----'     

>--+-----------------------------+--+---------------------+----->
   '-,NOENTER--=--+-(--R--n--)-+-'  '-,TYPE--=--+-TEST--+-'   
                  '-relexp-----'                '-ENTER-'     

>--+---------------------+--+----------------+------------------>
   |             .-YES-. |  '-,XPL--=--addrx-'   
   '-,AUTOTR--=--+-NO--+-'                       

>--+---------------------+-------------------------------------><
   |            .-4----. |   
   '-,MAXRC--=--+-code-+-'   

symbol
Although a label for this macro instruction is not required, it is highly recommended for tracing purposes.
exitid-code
Specifies the numeric id (0-255) of this $EXIT macro.  
JOBMASK=
Specifies the address, or a register that contains the address, of a 256-bit job exit mask in the job control table, of which each bit corresponds to an exit identification number; bit 0 corresponds to Exit 0, bit 1 corresponds to Exit 1, bit 2 to Exit 2, and so on. (This means, of course, that bit 2 corresponding to Exit 2 is really the third bit in the mask, and so on.) Initially, when the JCT is created, all the bits in the job exit mask are set to one. Use this operand only if the exit point is job-related, because the mask is used to determine whether the exit should be taken for a given job.
NOENTER=
Specifies a label to be branched to or a register to be branched on if the exit is not invoked (either because the bit for the exit is not on in the field specified in JOBMASK or because the exit is inactive). If you code TYPE=ENTER, do not code NOENTER.
TYPE=
Specifies how the exit effector is to treat this exit point.
If this parameter is omitted, the status of the exit point is to be determined and, if the exit is enabled, the exit effector is called to invoke the appropriate installation exit routines.
TEST
The exit effector tests the status of the exit point, and the exit effector sets a condition code as follows:
CC=0
Either the specific job mask bit for this exit is 0 or the exit id is not enabled (that is, no exit routines are to be called).
CC=1
The exit id is enabled but tracing is disabled.
CC=2
Both the exit id and tracing are active.
ENTER
The exit routine is to be entered through the exit effector without checking the status of the exit point. A $EXIT macro instruction should be coded with TYPE=TEST to confirm exit point status before coding a $EXIT macro with TYPE=ENTER.
AUTOTR=
Specifies whether tracing for this exit point is to be automatically provided by the exit effector. Possible values are as follows:
YES
YES specifies that tracing occurs if trace ID 13 is turned on (through a $TRACE command), and either the EXITnnn initialization statement specified TRACE=YES or the operator has entered a $T EXITnnn, TRACE=Y command for this exit point.
NO
No tracing takes place.
XPL
Address of the XPL to be passed to the exit. If specified in a register, the XPL is passed in that register to the exit. If specified in a field, it is loaded into R1.
MAXRC=
Specifies the maximum acceptable return code to be set by the installation exit routines. If this parameter is omitted, the default is 4.

Environment

  • Main task, subtask, user, or FSS address space.
  • $WAIT can occur if an installation exit routine issues a $WAIT or invokes a routine that issues a $WAIT.

Go to the previous page Go to the next page




Copyright IBM Corporation 1990, 2014