next up previous contents
Next: Modify Menu Prompt Up: Retained Menu Definition Previous: Define Response Command

Define User Information on Buttons

This Subroutine specifies the User Information Text that is associated with each Button for the currently setup Menu.

Short Name Calling Sequence

STATUS = UIDFUI(USTEXT,NBUTTS)

Long Name Calling Sequence

STATUS = UI_DEFINE_USER_INFO(...)

Input Arguments

USTEXT (Character Array) Button Information Text NBUTTS (Integer) No. of Buttons

Output Arguments

None

Function Value

UI__SUCCESS ) Success UISUCC )

UI__NOT_INITIALIZED ) Package Not Initialized UININI )

UI__ILLEGAL_MENU ) Illegal Menu ID UIILME )

UI__ILLEGAL_BUTTON ) Illegal No. of Buttons UIILBU ) Note:

  1. This subroutine operates on the currently setup Menu as defined by a prior call to UI_DEFINE_MENU or UI_USE_MENU.
  2. The USTEXT Argument is a Character Array (having NBUTTS elements) that contains the User Information Text to be associated with each item on the Menu.
  3. If the User Information Text corresponding to a particular Button is null (all spaces), then that Text is treated as a blank line and is skipped.
  4. A maximum of 256 buttons may be associated with a Menu. Thus NBUTTS may lie in the range 1-256.


Liz Buckle
Fri Jan 13 17:39:04 CST 1995