Display Command Line Window (QUSCMDLN) API

Default Public Authority: *USE

Threadsafe: No

The Display Command Line Window (QUSCMDLN) API displays a window containing a command line. A window is an area on the display that is treated as a separate display. Windows have visible boundaries and appear to overlay the display from which they are requested.

From the command line displayed, the user can:

Enter commands.
Retrieve commands and run programs.
Prompt for commands.
Use help for CL commands.
Request override commands. When the command line window is removed, all overrides are deleted.

Authorities and Locks

None.

Parameters

None.

Usage Notes

For consistency with other IBM^® i displays, you should use the F9 key to request a command line window.

The command line window produced by the QUSCMDLN API is shown at the bottom of the following display:

+--------------------------------------------------------------------------------+
| CSTINV                     Customer Invoice Menu                               |
|                                                                                |
| Select one of the following:                                                   |
|                                                                                |
|      1.  Enter or change orders                                                |
|      2.  Print picking slips                                                   |
|      3.  Release orders                                                        |
|      4.  Print invoices                                                        |
|                                                                                |
|                                                                                |
|                                                                                |
|                                                                                |
|                                                                                |
|                                                                                |
|                                                                                |
|                                                                                |
|                                                                                |
| .............................................................................. |
| :                                  Command                                   : |
| :                                                                            : |
| :  ===>                                                                      : |
| :  F4=Prompt   F9=Retrieve   F12=Cancel                                      : |
| :                                                                            : |
| :............................................................................: |
+--------------------------------------------------------------------------------+

Display Appearance Problems

There are two rare situations where portions of the underlying display might not be shown correctly while the command line window is shown. The underlying display is not actually changed, and it is shown correctly once the command line window is removed.

The situations are:

The underlying display is a text editor or other display that uses special work station printer mode functions. While the command line window is displayed, the special work station printer mode characters are not shown.
The underlying display is a bidirectional right-to-left display. While the command line window is displayed, the underlying display is flipped and shown from left-to-right.

Error Messages

Message ID	Error Message Text
CPF3C90 E	Literal value cannot be changed.
CPF9871 E	Error occurred while processing.

API Introduced: V1R3

[ Back to top | User Interface Manager APIs | APIs by category ]