Define Response Command Text on Buttons

This Subroutine specifies the Response Command Text that will be inserted into the Input Buffer when the associated Menu Button is selected for Action Menus only.

Short Name Calling Sequence

STATUS = UIDFRE(RETEXT,NBUTTS)

Long Name Calling Sequence

STATUS = UI_DEFINE_RESPONSES(...)

Input Arguments

RETEXT (Character Array) Button Response Text NBUTTS (Integer) No. of Buttons

Output Arguments

None

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 Verb UIILVB ) Note:

1. This Subprogram operates on the currently setup Menu as determined by a previous call to UI_DEFINE_MENU or UI_USE_MENU.
2. A maximum of 256 buttons may be associated with a Menu. Thus NBUTTS may lie in the range 1-256.
3. This Subprogram only has relevance when the associated Menu is to be used as an Action Menu.
4. The RETEXT Argument is a Character Array (having NBUTTS elements) that contains the Response Command Text to be associated with each item on the currently setup Menu. Upon later selection of a button this text will be inserted into the Input Buffer as if the User had typed it. A Response Command Text String may have up to 256 characters.
5. A Response Text String should commence either with a valid Verb for the Verb Group associated with the currently setup Menu, or with a Symbol (prefixed by an ``\&" character) that translates into a valid Verb, or with an Indirect Command File specification (prefixed with an ``@" character), where the first line of the Indirect File commences with a valid Verb.
6. If the Response Text array differs in the number of elements (NBUTTS) from the corresponding descriptive text array (see UI_DEFINE_BUTTONS), then missing buttons will be treated as having no Response Text associated with them and act as comment buttons.