WTOR()

CA-GSS Statements and Commands › GSS Extended Functions › IO Functions › Number, String, and Variable Functions › System Information Functions › WTOR()

WTOR()

Use the WTOR() function to display text on the operator console. WTOR() waits for the console operator's reply and returns it.

Syntax

The WTO() function produces these return codes:

101 - 102

ARG n MISSING OR INVALID

Example

msgid = wto('operator message',2,2) == '' /* Master console and
                                             highlight          */
x = dom(msgid)                            /* Delete the message */

Arguments

The WTOR() function takes these arguments:

reply	Reply from the operator (or error text).
text	Text to appear on the operator's console as the WTOR.
rout	One or more routing codes (like'1' or '1,2,3' or '1-5,8,10,15-128'). For information on routing, see the IBM manual Supervisor Services and Macro Instructions.
desc	One or more descriptor codes (like '1' or '1,2,3' or '1-5,8,10,12-16'). For information on routing and descriptor codes, see the IBM manual Supervisor Services and Macro Instructions.
cons	ID of the console to display the message. If the IMOD is being executed as the result of an operator's command, the imod_console variable will contain the console ID where the command was issued.

Usage Notes

WTOR() suspends execution of IMOD until an operator replies to the displayed message.
An IMOD with an outstanding WTOR cannot be canceled until the WTOR is satisfied.

Return Codes

The WTOR() function produces these return codes:

101	ARG 1 MISSING OR INVALID
102	One of the following for ARG 2: NON-NUMERIC CHARACTER CONTIGUOUS RANGES NUMBER TOO BIG LIST IS INCOMPLETE RANGE IS INVALID ZERO VALUE
103	One of the following for ARG 3: NON-NUMERIC CHARACTER CONTIGUOUS RANGES NUMBER TOO BIG LIST IS INCOMPLETE RANGE IS INVALID ZERO VALUE
104	CONSOLE ID INVALID

Example

wtor('an operator question') == 'ANSWER'   /* WTOR returns the reply*/

Tell Technical Publications how we can improve this information