Parameter descriptions for INMXZ01R

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

Figure 1. Exit-dependent data on entry to INMXZ01R

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

Address of the TRANSMIT PARM String (Parameter Entry 10)

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

Bit: Action
1... ....: TRANSMIT is to issue message INMX151I, 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), TRANSMIT 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 TRANSMIT issue message INMX151I, using the text contained in the parameter entry pointed to at offset +44.
..11 ....: Reserved
.... 1...: TRANSMIT is to send the data set that the exit specifies, instead of the data set indicated by the user. If the exit sets this bit to one, it also needs to return in the parameter entry at offset +64 the ddname of the data set to be sent.
.... .111: Reserved

Message Text (Parameter Entry 12)

Exits can put in this data field the message text that TRANSMIT is to issue with message ID INMX151I. 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 TRANSMIT 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 output target for TRANSMIT is not JES. The bit is on when the user specified either OUTDATASET, OUTDSNAME, OUTDDNAME, or OUTFILE on the TRANSMIT command.
.111 1111: Reserved

Address of a Text Unit Pointer List (Parameter Entry 14)

The data field contains the address of a text unit pointer list. The text units it points to identify the sender's node and user ID (INMFNODE and INMFUID). For more information about those text units or the text unit pointer list, see Text units and text unit pointer lists.

Note that the exit receives only copies of the actual text units; altering them has no effect on subsequent processing.

Address of a Text Unit Pointer List (Parameter Entry 15)

The data field contains the address of a text unit pointer list. The text unit it points to identifies the source of the data being transmitted -- either the data set name, the ddname, or an indication that the data was entered at the terminal (text units INMDSNAM, INDDNAM, or INMTERM, respectively). For more information about those text units or the text unit pointer list, see Text units and text unit pointer lists.

Note that the exit receives only copies of the actual text units; altering them has no effect on subsequent processing.

Address of the Addressee Chain (Parameter Entry 16)

The data field points to a chain of addresses to which the transmission is to be sent. By adding to, deleting, or changing information in the chain, the exit can control to whom the transmission is sent, and whether the sender receives an acknowledgment. Each entry in the chain has the following format:

Offset	Length	Value
+0	4	Pointer to the next entry in the chain, or zero to indicate the last entry.
+4	2	The length of the target node name or number specified either on the TRANSMIT command, or, if the issuer specified a nickname, in the associated entry in the NAMES.TEXT data set. Node numbers are valid for only JES2 nodes.
+6	8	Node name or number. The node name or number is left justified and padded with blanks. Node numbers are valid for only JES2 nodes.
+14	2	The length of the addressee's user ID.
+16	8	User ID. The user ID is left justified and padded with blanks.
+24	2	The length of the addressee's nickname. If no nickname is associated with the addressee, the value is zero.
+26	8	Nickname. The nickname is left justified and padded with blanks. If no nickname is associated with the addressee, the field is blank.
+34	2	The length of the addressee's name, taken from the :NAME tag in the NAMES.TEXT data set. If no name is found, or no nickname is associated with the addressee, the value is zero.
+36	30	Addressee's name. The name is left justified and padded with blanks. If no name is found, or no nickname is associated with the addressee, the field is blank.
+66	1	Flag byte: `1... ....` Request acknowledgment from this addressee `.1.. ....` Reserved `..1. ....` Transmission successfully completed `...1 1111` Reserved
+67	1	Reserved
+68	2	The length of the parameter string taken from the :PARM tag in the NAMES.TEXT data set. If no :PARM tag is found or no nickname is associated with the addressee, the value is zero.
+70	30	User parameter string on the :PARM tag in the NAMES.TEXT data set. The parameter string is left justified and padded with blanks. If no :PARM tag is found or no nickname is associated with the addressee, the field is blank.
+100	2	Halfword field that contains the length of the user ID specified at offset +102 in this entry. If the exit changes the length of that user ID, it needs to put the new length value in this length field.
+102	8	The sender's user ID. The field is left justified and padded with blanks. TRANSMIT places this user ID in the INMFUID text unit of the INMR01 header record of the transmission. Any changes the exit makes are reflected in INMR01. If the exit changes the length of the user ID, it also needs to put the new length value in the length field at offset +100.
+110	2	Halfword field that contains the length of the node name or number specified at the offset +112 in this entry. If the exit changes the length of that node name or number, it needs to put the new length value in this length field.
+112	8	The sender's node name or number. The field is left justified and padded with blanks. TRANSMIT places this node name or number in the INMFNODE text unit of the INMR01 header record of the transmission. Any changes the exit makes are reflected in INMR01. If the exit changes the length of the node name or number, it also needs to put the new length value in the length field at offset +110.

Ddname of the File to be Transmitted (Parameter Entry 17)

The exit can specify in this data field the ddname of a file to be transmitted in place of the data set, file, or terminal input specified by the user. If the exit puts a ddname in this field, it also needs to set action bit X'08' to one to request that TRANSMIT send the associated file.

Address of the User String for RECEIVE Exits (Parameter Entry 18)

The data field points to an area in which the exit can put a string to be passed to the RECEIVE data set exits (INMRZ11R, INMRZ12R, and INMRZ13R, or INMRZ11, INMRZ12, and INMRZ13) and the RECEIVE post-prompt exit (INMRZ15R).

If the exit specifies a string, it must also set the key and length fields to:

KEY:: X'00000002'
LEN:: Length of string. The maximum length is 247 bytes.

Address of a Notification String (Parameter Entry 19)

The data field points to an area in which the exit can put a notification string to be sent as part of the transmission. The notification string is passed to the RECEIVE notification exit (INMRZ04R or INMRZ04) and the RECEIVE acknowledgment notification exit (INMRZ05R). It is returned to the sender after RECEIVE processing completes. For more information about how you can use the notification string, see Installation-defined parameters.

If the exit specifies a string, it must also set the key and length fields to:

KEY:: X'00000002'
LEN:: Length of string. The maximum length is 64 bytes.