STAUTOLN - Start Automatic Line Numbering

Use the STAUTOLN macro instruction to start automatic line numbering. Automatic line numbering displays a line number at the beginning of each line.

This macro instruction can be used to cause the system to automatically prompt the user for input.

Once started, automatic line numbering is handled as follows: when the system has received a line of input, it immediately sends back to the terminal the next line number. If the program should send output while automatic line numbering is in effect, the line number will be repeated after all output has been sent to the terminal. For example:

00030 line of input
00040 OUTPUT MSG FROM PROGRAM
00040

Automatic line numbering is designed to be used by a program operating in input mode (that is, issuing successive TGET macros).

The system displays a new line number for each line of input received. The current line number maintained by the system is decreased appropriately whenever the input queue is cleared by a TCLEARQ macro or as the result of an attention interruption. Your application program is responsible for numbering the lines independently if it is creating a line numbered data set. The system line number is not available to the application program.

The system suspends automatic line numbering when the terminal user causes an attention interruption enters a null (nonprinting) line of input. The application program can then take appropriate action in an attention exit routine, or after receiving a zero length input from the TGET macro instruction. The application program can stop the line numbering function by using the SPAUTOPT macro instruction, or can restart the function by using either STAUTOLN or RTAUTOPT. You should use STAUTOLN rather than RTAUTOPT to restart automatic line numbering if the application program is numbering the input lines it receives. This choice will insure that the program's numbers are still in synchronization with the system's numbers.

The STAUTOLN macro instruction can be used only in a time sharing environment. It is ignored if issued by a batch task or if your program is running under Session Manager.

Figure 1 shows the format of the STAUTOLN macro instruction. Each of the operands is explained following the figure.

Figure 1. The STAUTOLN macro instruction

[symbol]     STAUTOLN       S=address, I=address

S=address: indicates the address of a fullword that contains the number to be assigned to the first line of terminal input. This number can be any integer from 0 to 99,999,999.
I=address: indicates the address of a fullword that contains the increment value to be used when assigning line numbers to lines of terminal input. This number can be any integer from 0 to 99,999,999.

When control is returned to the user, register 15 contains one of the following return codes:

Table 1. Return codes from STAUTOLN
Return code dec(Hex)	Meaning
0(0)	Successful. A line number will be printed at the beginning of each line of input.
4(4)	A parameter is not valid because the specified value is out of range.