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


Parameter descriptions for INMRZ11

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

When INMRZ11 receives control, register 1 points to the following parameter list. Note that many of the parameters are the same as those that INMRZ01 receives. Explanations of those parameters are not repeated here. For more information about them, see Parameter descriptions for INMRZ01.

Offset Length Value
+0 4 Address of an exit-to-exit communication word.
+4 4 Address of the character string that the user entered on the PARM keyword of the RECEIVE command.
+8 4 Address of a byte of action flags, which the exit can set to control RECEIVE processing after it returns.
Bit
Action
1... ....
RECEIVE is to issue message INMR151I, 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), RECEIVE is not to issue the normal error message. The exit either sends an appropriate message to the user, or requests that RECEIVE issue message INMR151I, using the text contained in the parameter pointed to at offset +16.
..11 ....
Reserved
.... 1...
RECEIVE is not to prompt the user. Instead, it is to use the reply the exit specifies in the area pointed to at offset +44. If bit X'01' is set to one, RECEIVE ignores it.
.... .1..
RECEIVE is to restore the incoming data to a temporary data set. The RECEIVE data set post-processing exit (INMRZ12R or INMRZ12) should complete processing the data.

Setting this bit to one does not prevent RECEIVE from prompting the user for allocation parameters to use in restoring the data; it only causes RECEIVE to ignore the user's reply. Thus, if you set this bit to one, you should also set bit X'08' to one, to prevent RECEIVE from prompting the user.

.... ..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
RECEIVE is to prompt the user for allocation parameters, and not take the action that RESTORE requests unless the user requests it. (RESTORE is the usual default action when processing data sets.) If action bit X'08' is one, RECEIVE ignores this bit.
+12 4 Address of the TSO/E command processor parameter list (the CPPL).
+16 4 Address of the message text that RECEIVE is to issue with message ID INMR151I.
+20 4 Address of a status flag byte. RECEIVE uses this byte to pass indicators to the exit.
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.
.1.. ....
RECEIVE does not recognize the input data. Either an error occurred in the transmission, or the data was sent by a program other than TRANSMIT or PROFS™.

If the exit is to process the data, it can get the address of the input DCB from offset +48. The exit can also get the ddname of the file via the text unit pointer list at offset +28.

Before processing the data, the exit must close then reopen the data set to ensure that it starts reading at the beginning. (When the exit receives control, RECEIVE has already read past any control records, and has read at least the first record of the data set.)

..11 ....
Reserved
.... 1...
RECEIVE is to restore the data to its original format and write it to the appropriate log, which is the action that RESTORE(LOG) requests, and the default when receiving messages.
.... .111
Reserved
+24 4 If the user entered a character string on the PARM keyword in response to the RECEIVE prompt, this parameter contains the address of that string.

The address points to an area that consists of a halfword length field followed by the character string. The length value is the length of the character string only. If no string is specified, the length value is zero.

+28 4 Address of a text unit pointer list. The list points to copies of text units that are sent with the transmission. They describe the incoming data, and can include:
INMBLKSZ  INMCREAT  INMDDNAM  INMDIR   INMDSNAM
INMDSORG  INMFM     INMEXPDT  INMLCHG  INMLRECL
INMLREF   INMMEMBR  INMRECFM  INMSIZE  INMTERM
INMSERP   INMUTILN 

For more information about those text units or text unit pointer lists, see Text units and text unit pointer lists. Note that altering the text units has no effect on subsequent processing. The exit receives copies of the actual text units for information only.

+32 4 Address of another text unit pointer list. The list points to copies of text units that are sent with the transmission. They identify the originator of the transmission, and can include:
INMFACK   INMFNODE  INMFTIME  INMFUID  INMFVERS
INMLRECL  INMNUMF   INMUSERP

For more information about those text units or text unit pointer lists, see Text units and text unit pointer lists. Note that altering the text units has no effect on subsequent processing. The exit receives copies of the actual text units for information only.

+36 4 Address of a string taken from the :PARM tag in the addressee's nickname entry in the sender's NAMES.TEXT data set. The string is present if the TRANSMIT command specified a nickname directly or via a distribution list, and the entry for that nickname in the sender's NAMES.TEXT data set contains the :PARM tag.

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

+40 4 The TRANSMIT initialization exit (INMXZ01R or INMXZ01) can pass a user string to the RECEIVE data set exits, including INMRZ11. If it does, this data field contains the address of that string.

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

+44 4 The address of an area in which the exit can build a reply to the RECEIVE command prompt. The address points to an area that consists of a halfword length field followed by a halfword of zeros, followed by 255-bytes (X'FF') where the exit can supply the prompt data. At entry the length field contains 259 bytes (X'0103'). This value denotes the maximum length of the buffer. To supply a receive prompt, the exit must do the following:
  1. Set bit X'08' in the action flags (parameter entry 11) on to indicate that RECEIVE is not to prompt the user.
  2. Supply the data for the RECEIVE reply in the 255-byte (X'FF') area.
  3. Set the halfword length field in the header to the length of the reply that was supplied, plus a 4-byte header.
+48 4 Address of the input DCB that identifies the data set being received. Before reading the data, the exit must close then reopen the data set to ensure that it starts reading at the beginning. (When the exit receives control, RECEIVE has already read past any control records, and has read at least the first record of the data set.)

Go to the previous page Go to the next page




Copyright IBM Corporation 1990, 2014