DOM

Syntax:

DOM(wtoid)

Arguments:

wtoid
the system identification number of the operator console message. This number is returned by the WTO function when the message is created.

Module Name:

SWXDOM

Service Description:

The DOM function is used to remove messages from the operator console. Most Write-To-Operator ( WTO ) messages will scroll off of the console display automatically. However, high-intensity, non-scrollable messages will remain on the console until the operator initiates an action to remove them (such as the "K S,1" command) or the program uses the DOM service to remove them. If you attempt to DOM a message that is no longer on the console, it is not an error.

Note: It is not necessary to DOM Write-To-Operator-with-Reply messages that have been generated by the Shadow REXXTOOLS WTOR function. The WTOR function will automatically DOM the message for you before returning control to your program.

Returned Information:

The MVS DOM macro does not return a useful return code. Therefore, the DOM function always returns a value of zero. If you CALL the DOM function the RESULT special variable will contain zero, also. The RC special variable remains unchanged.

Examples:

  1. Call the DOM function to remove a message from the console:
    call dom MsgWTID
    
    In this example the message deleted is the one given by the number contained within the REXX variable, MSGWTID. This variable was previously set by a call to the WTO function.


© Copyright 1998 by Open Software Technologies, Inc.