Parameter descriptions for INMRZ01R

When INMRZ01R receives control, register 1 points to the standard exit parameter list. For more information about the parameter list, see 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 INMRZ01R receives beginning at offset +36 (decimal).

Figure 1. Exit-dependent data on entry to INMRZ01R

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

Address of 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...: RECEIVE is to bypass normal authorization checking and continue processing. The exit has validated the user ID in the parameter entry pointed to at offset +56.
.... .1..: The exit has determined that the user is not authorized to receive files for the user ID requested. RECEIVE processing ends.
.... ..11: Reserved

Message Text (Parameter Entry 12)

Exits can put in this data field the message text that RECEIVE 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 word 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... ....: The input source for RECEIVE is not JES. The bit is on when the user specified either INDATASET, INDSNAME, INDDNAME, or INFILE on the RECEIVE command.
.111 ....: Reserved
.... 1...: The user ID in the parameter entry pointed to by offset +56 is the user ID specified on the USERID parameter of the RECEIVE command.
.... .111: Reserved

User ID of RECEIVE Issuer (Parameter Entry 14)

The data field contains the user ID of the person who issued RECEIVE. The user ID is taken from the PSCBUSER field of the protected step control block (PSCB).

User ID Receiving For (Parameter Entry 15)

If the person who issued RECEIVE specified the USERID parameter, this data field contains the user ID specified. If USERID was not specified, this data field contains the user ID of the person who issued RECEIVE (the same user ID as in the parameter entry pointed to at offset +52).