VM

You can use the QMF message service to display a message to users after their commands are canceled, by using the following fields of the DXEXCBA control block:

XCBMGTXT

Contains the message text.

XCBERRET

Contains the error return code.

XCBMSGNO

Contains the message ID for an ISPF message definition if QMF was invoked under ISPF in TSO.

XCBPANEL

Contains the panel ID for an ISPF message help panel definition.

Upon entry to the governor, XCBMGTXT contains blanks, and XCBERRET contains binary zeros. The value of XCBERRET determines what message is displayed on the screen:

• If you want to use the message OK, command canceled, leave the zero value in XCBERRET.
• If you want to use the message A governor exit cancel occurred with return code xxxxx, use a nonzero value for XCBERRET; this nonzero value appears in the message in place of xxxxx.

If QMF initialization is canceled by the governor exit, the preceding messages for XCBMGTXT and XCBERRET appear in the user's trace data rather than on the screen.

Set XCBLOGM to 1 to log a message in the user's trace data for any function call in your own governor exit routine. If the value of XCBERRET is nonzero, the IBM-supplied governor logs cancellation messages in the user's trace data by setting the XCBLOGM field of the DXEXCBA control block to a value of 1.

An ISPF message definition can contain long message text and can designate a panel ID. To use the long text for a message and the designated panel for Help, fill XCBMSGNO with the message ID of the message definition and leave XCBMGTXT and XCBPANEL blank. If no HELP panel was designated in the message definition, the user receives no message Help.

To override the long-message specification in a message definition, place the new message text in XCBMGTXT. To override the panel specification, place the new panel ID in XCBPANEL. Placing a panel ID in XCBPANEL also provides message Help when the message definition doesn't specify a panel.

Leave XCBMSGNO blank if there is no relevant ISPF message definition. Then place the message text in XCBMGTXT, and the HELP panel ID, if any, in XCBPANEL. Leaving XCBPANEL blank, in this case, leaves the user without message help.

The governor can also log messages in the ISPF log file if QMF was invoked under ISPF. It can do this through the ISPF LOG service. For more information on the ISPF LOG service, refer to the appropriate ISPF Dialog Management Services manual.

The trace facility writes messages to the DSQDEBUG data set at a level of detail determined by the value of the XCBTRACE field of the DXEXCBA control block. Use a value of zero for XCBTRACE if you do not want messages to be logged (although initialization errors are logged unless you do not allocate a trace data set). Use a value of 1 or 2 in the U-setting of the trace option to get trace output. For additional details on using the QMF trace facility, see Using the QMF trace facility.

The IBM-supplied governor does not log messages for termination function calls. Messages do not appear on screen if the command is run in batch or noninteractively from a QMF application.