Use Action Menu Temporary

This Subprogram will display a Menu containing the specified title and buttons and prompt the User to supply input (either explicitly by typing a text string at the keyboard, or implicitly by selecting a Menu Button).

Short Name Calling Sequence

STATUS = UITEAC(TITLE,PROMPT,BUTEXT, & RETEXT,NBUTTS,VERB[,BUTTID])

Long Name Calling Sequence

STATUS = UI_TEMP_ACTION_MENU(...)

Input Arguments

TITLE (Character) Menu Title PROMPT (Character) Menu Prompt BUTEXT (Character Array) Button Descriptive Text RETEXT (Character Array) Button Response Text NBUTTS (Integer) No. of Buttons

Output Arguments

VERB (Character) Verb response BUTTID (Integer) Button ID (Optional)

Function Value

UI__SUCCESS ) Success UISUCC )

UI__NOT_INITIALIZED ) Package not Initialized UININI )

UI__ILLEGAL_BUTTON ) Illegal No. of Buttons UIILBU )

UI__ILLEGAL_VERB ) Illegal Response Verb UIILVB )

UI__NO_INPUT ) No Input present UINOIN )

UI__INPUT_ABORTED ) Input Aborted (Ctrl-Z) UIABRT )

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

1. In ViewText Mode of Operation, if the Menu Viewport 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.
2. 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.
3. The Verb portion of every non-null (not all spaces) Response must correspond to a valid Verb within the currently setup Group (via UI_USE_GROUP).
4. Buttons having a null (all spaces) Response Text are treated as Comment Buttons.
5. The VERB Argument returned to the caller is the full text (in upper case) of the verb portion of the Command Response Text associated with the selected Button. This Verb text will be truncated or padded out with trailing spaces as appropriate.
6. The BUTTID Argument is optional and, if present, will be set to the Button ID corresponding to the User Response.
7. NBUTTS may lie in the range 1-256.
8. 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.
9. 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.
10. 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).