Make a Comment Menu Button

This Subroutine converts the specified Menu Button (which must already have been defined by a prior call to UI_DEFINE_BUTTONS or UI_MODIFY_BUTTON) into a Comment Button, whereby the descriptive text associated with it will be displayed, but the Button itself will be passive and may not be selected. The Button may later be 'uncommented' via a call to UI_UNCOMMENT_BUTTON.

Short Name Calling Sequence

STATUS = UICOBU(BUTTID)

Long Name Calling Sequence

STATUS = UI_COMMENT_BUTTON(...)

Input Arguments

BUTTID (Integer) Button ID

Output Arguments

None

Function Value

UI__SUCCESS ) Success UISUCC )

UI__NOT_INITIALIZED ) Package not Initialized UININI )

UI__ILLEGAL_BUTTON ) Illegal Button ID UIILBU )

UI__ILLEGAL_MENU ) Illegal Menu UIILME ) 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. Button IDs range from 1-NBUTTS (as defined by UI_DEFINE_BUTTONS) for the currently setup Menu. A maximum of 256 buttons are allowed per menu.
3. Buttons are uncommented by default.