Parameter descriptions for INMCZ21R

When INMCZ21R receives control, register 1 points to the standard exit parameter list. The parameter list is described in TSO/E standard exit parameter list. Note that the TRANSMIT and RECEIVE exits do not use the new command buffer field in the parameter entry pointed to at offset +4. Following is a description of the exit-dependent data that INMCZ21R receives beginning at offset +36 (decimal) in the parameter list.

Figure 1. Exit-dependent data on entry to INMCZ21R

Following are descriptions of the information in the data fields of each parameter entry:

Address of the Command PARM String (Parameter Entry 10)

If the user entered a character string on the PARM keyword of the command, this data field contains the address of that string. If a string was specified:

KEY:: X'00000002'
LEN:: Length of the string

If no string was specified:

KEY:: X'00000000'
LEN:: X'00000004'

For more information about how you can use the command PARM keyword, see Installation-defined parameters.

Action Flags (Parameter Entry 11)

The data field contains a word of action flags, which the exit can set to control TRANSMIT and RECEIVE processing after it returns. The flags in byte 0 are defined as follows. Bytes 1, 2, and 3 are reserved.

Bit: Action
1... ....: TRANSMIT or RECEIVE is to issue message INMC151I, using the text contained in the parameter entry pointed to at offset +44.
.1.. ....: If the return code from the exit is non-zero (end processing), the command is not to issue the normal error message. The exit either: already sent an appropriate message to the user; set return code 12, which causes message IKJ79154I to be issued; or requested that the command issue message INMC151I, using the text contained in the parameter entry pointed to at offset +44.
..11 ....: Reserved
.... 1...: The exit has allocated the NAMES data set. The ddname representing the data set is contained in the parameter entry pointed to by offset +56.
.... .1..: The exit has modified the NAMES data set name that was passed in the parameter entry pointed to by offset +52.
.... ..1.: The exit tried to allocate the NAMES data set, but the allocation failed.
.... ...1: Reserved.

Message Text (Parameter Entry 12)

Exits can put in this data field the message text that the command is to issue with message ID INMC151I. The field initially contains blanks. If the exit inserts text in the data field, it must also set the key and length values to:

KEY:: X'00000001'
LEN:: Length of the message text. The maximum length is 243.

Status Flags (Parameter Entry 13)

The data field contains a word of status flags in which the command passes indicators to the exit. The flags in byte 0 are defined as follows. Bytes 1, 2 and 3 are reserved.

Bit: Meaning
1... ....: TRANSMIT or RECEIVE is not interfacing with JES. A data set keyword (INDSNAME, INDATASET, OUTDSNAME, OUTDATASET) or a file keyword (INFILE, INDDNAME, OUTFILE, OUTDDNAME) was specified.
.111 ....: Reserved
.... 1...: Exit is operating under TRANSMIT
.... 0...: Exit is operating under RECEIVE
.... .111: Reserved

Data Set Name (Parameter Entry 14)

On entry the data field contains the name of the NAMES data set to be allocated by either the command invoking the exit or the exit itself.

If the exit modifies the NAMES data set name it must also update the length and key fields accordingly; and it must set the X'04' action flag to indicate that modifications were made to the NAMES data set name.

On return this information is used by the TRANSMIT or RECEIVE command to decide which NAMES data set to allocate and free (provided the allocate is not done by the exit itself, see parameter entry 15).

If the content of the length field is incorrect, the parameter is ignored and processing continues as it would have if the exit did not modify the NAMES data set name.

Note that if you want the exit to modify the NAMES data set name and to allocate the NAMES data set you must specify parameter entries 14 and 15.

DDNAME (Parameter Entry 15)

If the exit is to allocate the NAMES data set to a file, the file name should be placed in this parameter entry. Update the key and the length field accordingly. The length field must reflect the length of the file name. The X'08' action flag should be set to indicate that the data set has been allocated from within the exit.

Upon return from the exit the invoking TRANSMIT or RECEIVE command uses this information to free the allocated NAMES data set.

If the content of the length field is incorrect, the parameter is ignored and processing continues as it would have if the exit did not modify this parameter entry.

Note that if you want the exit to modify the NAMES data set name and to allocate the NAMES data set you must specify parameter entries 14 and 15.