>>-+--------+--$WTO--+-message-addrx-+--,--+-length-absexp-+---->
'-symbol-' '-(--R1--)------' '-(--R0--)------'
>--+--------------------+--+-------------------+---------------->
| .-YES-. | '-,--ROUTE--=--code-'
'-,--JOB--=--+-NO--+-'
>--+---------------------------+--+------------------------+---->
'-,--CLASS--=--+-$DOMACT--+-' | .-YES-. |
+-$NORMAL--+ '-,--DOMTERM--=--+-NO--+-'
'-$JOBSTAT-'
>--+----------------------------------------+------------------->
'-,--TEXT--=--+-message-addrx----------+-'
'-message-addrx--+-,C--+-'
+-,L--+
+-,D--+
+-,DE-+
'-,E--'
>--+----------------------+------------------------------------><
'-,--CONNECT--=--conid-'
- message
- Specifies the address of a message that is to be displayed on
the designated consoles. If register notation is used, the address
must be loaded into the designated register before the execution of
this macro instruction. If the message begins with $HASP, the $ will
be replaced by the value specified on the CONCHAR= parameter of the
CONDEF initialization statement. Do not use $MSG to generate messages
issued with the $WTO macro in the user or subtask environment.
- length
- Specifies the length of the above message. If register notation
is used, the value must be loaded into the rightmost byte of the register
(R0) before the execution of the macro instruction. The rest of the
register must be 0. The maximum message length is 125 bytes if JOB=NO
and 116 bytes if JOB=YES.
- CLASS=
- Specifies the class of the message as one of the following:
- $DOMACT
- The message requires immediate action and is always written. (MCS
descriptor code 2)
On return from $WTO processing, register 1 contains
the DOMID. The $WTO caller is responsible for issuing the DOM macro
to delete the message using the DOMID passed back.
- $NORMAL
- The message is considered important to normal computer operations.
(MCS descriptor code 4)
- $JOBSTAT
- Descriptor code is set to MCSJOBST. (MCS descriptor code 6)
If you omit this operand, $NORMAL is assumed.
- CONNECT=
- If the second or subsequent line of a multi-line WTO, specifies
the MLWTO connect ID. Only valid if TEXT= was specified.
- DOMTERM=
- Enables you to specify whether an outstanding action message is
to be deleted after the issuing task terminates. DOMTERM= is meaning
only if CLASS=$DOMACT.
- YES
- Indicates that you want the outstanding action message deleted
when the issuing task terminates. This applies to messages issued
with CLASS=$DOMACT. When issuing a message for which DOMTERM=YES has
been specified, JES2 uses MCS descriptor code 7 in addition to currently
used descriptor codes. YES is the default.
- NO
- Indicates that this outstanding action message should still be
displayed after the issuing task terminates.
- JOB=
- Specifies whether the job identification and job name from the
JSAB (or ASCB if no JSAB) are inserted in the message and passed to
WTO.
Note: If you are in input services (internal reader or NETSRV)
and want to use the job information for the submitted job, use $BLDMSG
with the JOB= specification instead of $WTO.
- YES
- The job information is inserted in the message and passed to WTO.
The jobname is inserted in the message only if it begins with "$HASP"
and then is inserted into position 10 of the message between the $HASPnnn and the message text.
- NO
- The job information is not inserted in the message.
If this operand is omitted, JOB=YES is assumed.
- ROUTE=
- Specifies the JES2 logical routings that are converted to operating
system equivalent routings as follows:
- Designation
- Console Specified
- $LOG
- Hard-copy console (MCS route code 0)
- $ERR
- Error consoles (MCS route code 10)
- $MCINFO
- Master console information (MCS route code 2)
- $PGINFO
- Programmer information (MCS route code 11)
- 0
- Hard copy only (MCS route 0)
Note: You can specify multiple values, for example,
ROUTE=$LOG+$PGINFO.
If this operand is omitted it defaults
to $LOG.
- TEXT=
- Specifies the address of a half-word length followed by the text
of the operator message. The address can be in a register (2-12) or
be the name of a field. The length does not include the length of
the half-word containing the length. The maximum message length is
125 bytes if JOB=NO and 116 bytes if JOB=YES.
If the message begins
with "$HASP" the $ will be replaced by the value specified on the
CONCHAR= parameter of the CONDEF initialization statement.
A
second optional value is the line type for multi-line WTOs. Valid
values are C, L, D, DE, and E. See the WTO macro for complete descriptions.
The connect id is returned in register 1. This is for specification
in CONNECT= on subsequent lines of a multi-line WTO.
Note: - ROUTE=$LOG with no other route codes instructs JES2 to route message
to hardcopy only.
- The positional message and length operands are mutually exclusive
with TEXT=.