Fetch Menu Button Descriptive Text

This Subroutine allows the Descriptive Text associated with a previously defined Menu Button on the currently setup Menu to be fetched (retrieved).

Short Name Calling Sequence

STATUS = UIFHBU(BUTTID,BUTEXT[,BULENG])

Long Name Calling Sequence

STATUS = UI_FETCH_BUTTON(...)

Input Arguments

BUTTID (Integer) Button ID

Output Arguments

BUTEXT (Character) Button Descriptive Text BULENG (Integer) Length of Button Text (Optional)

Function Value

UI__SUCCESS ) Success UISUCC )

UI__NOT_INITIALIZED ) Package not Initialized UININI )

UI__ILLEGAL_MENU ) Illegal Menu ID UIILME )

UI__ILLEGAL_BUTTON ) Illegal Button ID UIILBU )

UI__TRUNCATED ) Button Text Truncated UITRUN ) 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 BUTEXT Argument will be set to spaces if the specified Button does not exist on the currently setup Menu.
3. The BULENG Argument is optional and, if present, will be set to the length of the Button Descriptive Text after any truncation.
4. The UI__TRUNCATED and UI__ILLEGAL_BUTTON Function values are informational only, no error message will be signalled.