z/OS TSO/E Customization
Previous topic | Next topic | Contents | Contact z/OS | Library | PDF


Parameter descriptions for INMXZ01

z/OS TSO/E Customization
SA32-0976-00

When INMXZ01 receives control, register 1 points to the following parameter list:

Offset Length Value
+0 4 Address of an exit-to-exit communication word. TRANSMIT exits can use this word to communicate among themselves by passing information in the storage to which it points. INMXZ01 can obtain the block of storage, and make it available to all exits by storing the address in the exit-to-exit communication word. TRANSMIT initially sets the value of the word to zero, and thereafter, does not modify it or the contents of the storage to which it points.
+4 4 Address of the character string that the user entered on the PARM keyword of the TRANSMIT command. For more information about how you can use the TRANSMIT PARM keyword, see Installation-defined parameters.

The address points to an area consisting of a halfword length field followed by the character string. The length field specifies the length of the character string. If no string was specified, the value in the length field is zero.

+8 4 Address of a byte of action flags, which the exit can set to control TRANSMIT processing after it returns.
Bit
Action
1... ....
TRANSMIT is to issue message INMX151I, using the text contained in the parameter pointed to at offset +16.
.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 sent an appropriate message to the user, or requested that TRANSMIT issue message INMX151I, using the text contained in the parameter pointed to at offset +16.
..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 at offset +36 the ddname of the data set to be sent.
.... .111
Reserved
+12 4 Address of the TSO/E command processor parameter list (the CPPL). The exit can use the parameter list to examine the initial TRANSMIT command, or to build an IOPL for invoking the TSO/E I/O service routines.
+16 4 Address of the message text that TRANSMIT is to issue with message ID INMX151I. When the exit is invoked, the address points to an area consisting of a halfword length field, followed by an area in which the exit can insert message text. The length value at entry is zero.

Exits that pass back message text must put the length of text into the length field. (Do not include the halfword of the length field in the length specification.) The maximum length is 243 bytes.

+20 4 Address of a status flag byte. TRANSMIT uses this byte to pass indicators to the exit.
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
+24 4 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.

+28 4 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.

+32 4 Address of a chain of addresses to which the transmission is to be sent. By adding to, deleting, or changing the information specified in the chain, the exit can control to whom the transmission is sent, and whether the sender receives an acknowledgment.

See Table 1 for the address chain format.

+36 4 Address of an 8-byte area in which the exit can return a ddname that represents an allocated data set. TRANSMIT is to send that data set instead 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.
+40 4 Address of an area in which the exit can put a string to be passed to RECEIVE data set exits (INMRZ11, INMRZ12, and INMRZ13, or INMRZ11R, INMRZ12R, or INMRZ13R) and the RECEIVE post-prompt exit (INMRZ15R).

The area consists of a halfword length field, followed by a 247-byte data field. If the exit puts a string in the data field, it also needs to update the length field to reflect the actual length of the data inserted. The value of the length field is initially zero. If the length field is a negative value, RECEIVE ignores the parameter. If length of the data inserted is greater than 247 bytes, TRANSMIT uses only the first 247 bytes, and sets the length to 247.

+44 4 Address of 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 (INMRZ04 or INMRZ04R) 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.

The format of the area is a halfword length field, followed by a 64-byte data field. If the exit puts a string in the data field, it needs to update the length field to reflect the actual length of the data inserted. The value of the length field is initially zero. If the length field is a negative value, RECEIVE ignores the parameter. If length of the data inserted is greater than 64 bytes, TRANSMIT uses only the first 64 bytes, and sets the length to 64.

Each entry in the address chain has the following format:

Table 1. Address Chain 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.

Go to the previous page Go to the next page




Copyright IBM Corporation 1990, 2014