Next: Use Real Menu
Up: Temporary Menu Useage
Previous: Use Toggle Menu
This Subprogram will display a Menu containing the specified Buttons and
prompt the User to modify any of the Integer values displayed.
Short Name Calling Sequence
STATUS = UITEIN(TITLE,PROMPT,BUTEXT,NBUTTS,
& ITEMS[,LOLIM,HILIM])
Long Name Calling Sequence
STATUS = UI_TEMP_INTEGER_MENU(...)
Input Arguments
TITLE (Character) Menu Title
PROMPT (Character) Menu Prompt
BUTEXT (Character Array) Button Descriptive Text
NBUTTS (Integer) No. of Buttons
ITEMS (Integer Array) Defaults
LOLIM (Integer Array) Lower Limits (Optional)
HILIM (Integer Array) Upper Limits (Optional)
Output Arguments
ITEMS (Integer Array) Values
Function Value
UI__SUCCESS ) Success
UISUCC )
UI__NOT_INITIALIZED ) Package not Initialized
UININI )
UI__ILLEGAL_BUTTON ) Illegal No. of Buttons
UIILBU )
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:
- 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.
- 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.
- The range of allowed values for each array element may be limited by
specifying the optional LOLIM and HILIM arrays.
- NBUTTS may lie in the range 1-256.
- 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.
- 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.
- 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).
Next: Use Real Menu
Up: Temporary Menu Useage
Previous: Use Toggle Menu
Liz Buckle
Fri Jan 13 17:39:04 CST 1995