Use Text Menu Retained

This Subprogram will display the specified Menu (if it isn't already displayed) and prompt the User to modify any of the Text Values associated with the Menu Buttons.

Short Name Calling Sequence

STATUS = UITXME(MENUID,ITEMS)

Long Name Calling Sequence

STATUS = UI_TEXT_MENU(...)

Input Arguments

MENUID (Integer) Menu ID ITEMS (Character Array) Defaults

Output Arguments

ITEMS (Character Array) New Values

Function Value

UI__SUCCESS ) Success UISUCC )

UI__QUAL_PRESENT ) Qualifier Present UIQUPR )

UI__NOT_INITIALIZED ) Package not Initialized UININI )

UI__ILLEGAL_MENU ) Illegal Menu ID UIILME )

UI__NO_INPUT ) No Input UINOIN )

UI__INPUT_ABORTED ) Input Aborted (Ctrl-Z) UIABRT )

UI__END_OF_FILE ) End-of-File detected UIEOF ) in Batch Mode

Note:

1. Depending on the currently setup Mode of Operation, the specified Menu will be displayed (if it isn't already displayed) and the Operator will be prompted to supply input (either from the keyboard or by movement of the Cursor around the screen).
2. In ViewText Mode of Operation, if the Viewport associated with the Menu is hidden (invisible) it will be displayed and then hidden once the User has responded to the Menu Prompt. If the Viewport should be kept visible it must be made explicitly visible (via a call to UI_DISPLAY_VIEWPORT) prior to this call.
3. It is possible that the Menu Viewport is still hidden by other visible Viewports if its priority is lower than them. It is the Application Programmers responsibility to ensure that the relative priorities are adjusted so as to avoid this.
4. The Text Strings associated with each Menu Button may be up to 32 Characters in length.
5. UI__NO_INPUT will only be returned in Asynchronous Mode and indicates that the User has not yet specified any Input. The Application Program should poll using UI_TEST_INPUT until this indicates that some Input has been received, and recall this Subprogram.
6. The UI__INPUT_ABORTED Function Value indicates that the User typed Ctrl-Z to abort input. This is only implemented on a VAX/VMS system. It is an informational function value only, no error message will be reported.
7. The UI__END_OF_FILE Function Value indicates that an End-of-File was detected on the main Input Stream in Batch or non-interactive mode where Input is not taken from a terminal but rather from a file. It is a severe error and therefore causes an error to be reported (unless this has been inhibited by a prior call to UI_ERROR_LEVEL).