Parameter descriptions for INMRZ21R

When INMRZ21R 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 INMRZ21R receives beginning at offset +36 (decimal) in the parameter list.

Figure 1. Exit-dependent data on entry to INMRZ21R

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

Address of the RECEIVE PARM String (Parameter Entry 10)

If the user entered a character string on the PARM keyword of the RECEIVE 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 RECEIVE 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 RECEIVE processing after it returns. The flags in byte 0 are defined as follows. Bytes 1, 2, and 3 are reserved.

Bit: Action
1... ....: RECEIVE is to issue message INMR151I, 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), RECEIVE 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 RECEIVE issue message INMR151I, using the text contained in the parameter entry pointed to at offset +44.
..11 ....: Reserved
.... 1...: The exit has allocated the log 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 log data set name that was passed in the parameter entry pointed to by offset +52.
.... ..11: 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 INMR151I. 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 byte of status flags in which RECEIVE passes indicators to the exit. The flags in byte 0 are defined as follows. Bytes 1, 2, and 3 are reserved.

Bit: Meaning
1... ....: RECEIVE is not interfacing with JES. A file keyword (INFILE, INDDNAME) was specified.
.111 1111: Reserved

Data Set Name (Parameter Entry 14)

The data field contains the name of the log data set that will be allocated by the command. If the exit chooses to modify the data set name, the length field should be updated to reflect the correct length of the data set name. In addition, if the exit modifies the data set name, the X'04' action flag should be set to indicate that modifications were made. If the exit updates this parameter entry, update the length and key fields accordingly. If the length fields are incorrect, the parameter is ignored and processing continues as it would have if the exit did not modify this parameter.

DDNAME (Parameter Entry 15)

If the exit allocates the log data set to a file, the file name should be placed in this parameter entry. The length should be updated to reflect the length of the file name. If the exit allocates the data set, the X'08' action flag should be set to indicate that the data set has been allocated. If the exit allocates the data set, the command will free the data set through normal processing.

If the exit updates this parameter entry, update the length and key fields accordingly. If the length fields are incorrect, the parameter is ignored and processing continues as it would have if the exit did not modify this parameter.