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

Previous Topic: MEMORY()

Next Topic: OPSVALUE()
MLWTO()

Use the MLWTO() function to issue the specified text as a multi-line WTO.

Syntax

The MLWTO() function has this syntax:

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

Arguments

The MLWTO() function takes these arguments:

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.

Root name of a stem variable containing the text to be issued. Include the period. CA recommends that the name be 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 will be used in collating sequence. If you create them in ascending collating sequence, you will not need to rename them later.

The variable created first is used for the control line. Up to 25 additional 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 currently reserved.
  • The stem variable cannot be global; that is, it cannot begin with an ampersand (&).

 

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

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

rout

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

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 (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 will contain the console ID of the console issuing the command.

area

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

Return Codes

The MLWTO() function produces these return codes:

101

One of the following for ARG 1:

ARG 1 MISSING OR INVALID

STEM VARIABLE NOT FOUND

STEM HAS NO MEMBERS

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

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