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

Previous Topic: WAIT()

Next Topic: WTOR()
WTO()

Use the WTO() function to issue the specified text as a WTO.

Syntax

The WTO() function has this syntax:

msgid = WTO(text,[rout],[desc],[cons])

Arguments

The WTO() function takes these arguments:

msgid

Unique message ID assigned by the operating system. Can be used with the DOM() function to delete messages no longer needed. If the WTO fails, error information is returned.

text

Text to appear on the operator's console as a WTO.

rout

One or more routing codes (like '1' or '1,2,3' or '1-5,8,10,15-128'). For information on routing codes, see the IBM manual Supervisor Services and Macro Instruction.

desc

One or more descriptor codes (like '1' or '1,2,3' or '1-5,8,10,12-16'). For information on descriptor codes, see the IBM manual Supervisor Services and Macro Instructions.

cons

Number of console to receive message. If the IMOD is running as the result of an operator command, the predefined variable imod_console contains the console ID of the console issuing the command.

Return Codes

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 */