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

MLWTO()

This function issues the specified text as a multi-line WTO.

Syntax

msgid = MLWTO([stem.],[rout],[desc],[cons],[area])

Parameters

msgid

System-assigned ID. Value can be passed to the DOM() function to delete message from the console. If function fails, error text is returned.

stem

The root name of a stem variable containing the text to be issued. Include the period. We recommend that the name is enclosed within quotation marks.

The stem items are used as text lines, in the order created (not by index value). In future releases of CA-GSS, the variables are used in collating sequence. If you create them in ascending collating sequence, you do not need to rename them later.

The variable that is created first is used for the control line. Up to 25 more lines are used as data lines. The following restrictions apply:

• The control line cannot exceed 34 characters.
• Data lines cannot exceed 70 characters each.
• You cannot use the stem.0 variable. It is reserved.
• The stem variable cannot be global; that is, it cannot begin with an ampersand (&).

rout

To reuse the variables with fewer lines, use the REXX DROP command for the stem. This deletes the entire stem group and lets you create a set with fewer variables.

If you omit the stem variable, the contents of the WTO are the entire current contents of the currently accessed stack.

desc

One or more routing codes (like'1' or '1,2,3' or '1-5,8,10,15-128').

One or more descriptor codes (like '1' or '1,2,3' or '1-5,8,10,12-16').

For information about routing and descriptor codes, see the IBM guide Supervisor Services and Macro Instructions (GC28-1154-4).

cons

Console ID to receive the message.

If the IMOD is being executed as the result of an operator command, the predefined variable imod_console contains the console ID of the console issuing the command.

area

Console area where the message is displayed. This argument only has an effect if the destination console has defined the requested area. If area is omitted or not defined, the message appears in the standard display area of the console.

Return Codes

101

One of the following codes for ARG 1:

ARG 1 MISSING OR INVALID

STEM VARIABLE NOT FOUND

STEM HAS NO MEMBERS

102

One of the following codes for ARG 2:

NON-NUMERIC CHARACTER

CONTIGUOUS RANGES

NUMBER TOO BIG

LIST IS INCOMPLETE

RANGE IS INVALID

ZERO VALUE

103

One of the following codes for ARG 3.

NON-NUMERIC CHARACTER

CONTIGUOUS RANGES

NUMBER TOO BIG

LIST IS INCOMPLETE

RANGE IS INVALID

ZERO VALUE

104

CONSOLE ID INVALID

105

AREA INVALID

Example

queue 'label line'              /* Get messages ready */
queue 'message line 1'
queue 'message line 2'
msgid = mlwto()                 /* Issue queued messages using 
                                   system defaults*/