ULHMX1 - Hello Message Exit

ULHMX1 is a user-written routine called by Com-plete's hello message transient, TTOCHM, before the hello message is sent to a terminal.

ULHMX1 not only allows you to modify the contents of the hello message before sending it to a terminal, but it can also indicate that no hello message is to be sent to a specific terminal.

ULHMX1 is entered once for each terminal that is to receive a hello message, either during Com-plete initialization if sysparm HELLOMESSAGE=YES is specified, or during processing of the HMSG operator command. ULHMX1 is loaded during initialization.

This document covers the following topics:

How to Use ULHMX1

Upon entry to ULHMX1, a set of parameters is provided to supply the exit with the information necessary to perform its function. The first parameter is the address of a message switching control block, as built by MCALL MESGCB, specifying the message class codes and other data for the hello message. The second parameter is the address of the message text to be sent. The third parameter is the address of a halfword containing the length of the message to be sent.

The fourth parameter is the address of the TID number to receive the message. The TID number is in the form of an eight-character, printable number. For example, TID 178 would be "00000178". The fifth parameter is the address of a halfword containing the number of terminals to receive the message. This halfword is always one (1). The sixth parameter is the address of the installation ID and is used to identify the originator of the message. The installation ID is eight characters long.

The addresses in the parameter list can be changed to specify different messages and lengths. Note that the locations pointed to by the parameter list must not be modified.

ULHMX1 Conventions

The following table summarizes the ULHMX1 linkage conventions.

Feature Convention
Attributes None required.
Type Nucleus.
Size No restriction.
Registers at Entry
Register 1 Address of the parameter list
Register 2 Address of the Com-plete COMREG
Register 13 Address of an 18-word save area
Register 14 Address of the return point in TTOCHM
Register 15 Address of the ULHMX1 entry point
Registers at Return Registers 2 through 13 must be unchanged.
Parameters
Word 1 Address of the MESGCB
Word 2 Address of the message text
Word 3 Address of a halfword message length
Word 4 Address of the TID
Word 5 Address of the halfword terminal count (1)
Word 6 Address of the installation ID
Return Codes
0 Send message.
4 Do not send message.
Considerations
a Executes in supervisor state, and key of Com-plete.
b Cannot issue Com-plete user functions.