Parameter descriptions for INMRZ13R

When INMRZ13R 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 INMRZ13R receives beginning at offset +36 (decimal).

Figure 1. Exit-dependent data on entry to INMRZ13R

Many of the parameters are the same as those that INMRZ01R and INMRZ11R receive. Explanations of those parameters are not repeated here. For more information about them, see Parameter descriptions for INMRZ01R or Parameter descriptions for INMRZ11R.

Following are descriptions of only those parameters that are different.

Action Flags (Parameter Entry 11)

The data field contains a word of action flags, which the exit can set to control RECEIVE processing after the exit 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 not to issue the REPRO command. Either the exit deciphered the data, or no deciphering is required.
If the exit deciphered the data, RECEIVE assumes that the exit copied the data from the file identified by the enciphered data ddname to the file identified by the plain text data ddname. Those ddnames are contained in the parameter entries pointed to at offsets +76 and +80, respectively.
.... .1..: Reserved
.... ..1.: All processing on the current file is complete. If the return code from the exit is zero, no more processing is done on the file. RECEIVE can delete the file from the JES spool and process the next file, if one exists.
If the return code is non-zero, RECEIVE ignores this bit.
.... ...1: Reserved

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 1111: Reserved

Address of REPRO Options (Parameter Entry 19)

The data field points to an area that contains the options the user specified on the DECIPHER keyword of the REPRO command. RECEIVE uses that information to build a REPRO control statement that looks like:

REPRO INFILE(infile) OUTFILE(outfile) DECIPHER(options specified by
user and INMRZ13R)

The exit can modify the DECIPHER options. The modified information is used in decryption processing.

If the exit changes the length of the options string, it must also change the value in the length field accordingly. The maximum length allowed is 253 bytes. If the length of the data inserted is greater than 253 bytes, RECEIVE uses only the first 253 bytes, and sets the length to 253.

Ddname of Encrypted Data File (Parameter Entry 20)

The data field contains the ddname of the file that contains the encrypted data. The data set that corresponds to the ddname is a temporary data set that RECEIVE allocated. Do not modify this field.

Ddname of File for Decrypted Data (Parameter Entry 21)

The data field contains the ddname of the file to which the deciphered data is to be written. The file might or might not be the final output of RECEIVE processing. (For example, if partitioned data sets are being transmitted, the file contains them in their unloaded form.) Do not modify this field.

Address of a String from INMRX03R (Parameter Entry 22)

The TRANSMIT data set encryption exit (INMXZ03R or INMXZ03) can pass a user string to this exit. If it is does, 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'