Define a new Menu

This Subprogram may be used to define a new Menu to which all subsequently defined Buttons will belong. This request will be treated as illegal if the currently setup Group is Locked.

Short Name Calling Sequence

STATUS = UIDFME(MENUID,TITLE,PROMPT)

Long Name Calling Sequence

STATUS = UI_DEFINE_MENU(...)

Input Arguments

MENUID (Integer) Menu ID TITLE (Character) Menu Title PROMPT (Character) Menu Prompt

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_GROUP ) Illegal Group UIILGP )

UI__LOCKED_GROUP ) Group Locked UIGLOK )

Note:

1. Menu IDs may lie in the range 0-4095. An attempt to define a Menu ID outside this range will result in a UI__ILLEGAL_MENU return.
2. The TITLE Argument contains a text string that will be displayed at the head of the Menu.
3. The PROMPT Argument contains a text string that will be displayed at the foot of the Menu in simple scroll mode and prompted mode.
4. The specified Menu will be associated with the currently setup Verb Group.
5. Error UI__LOCKED_GROUP will be returned if the currently setup Verb Group has been locked by a prior call to UI_LOCK_GROUP.