next up previous contents
Next: Inquire Operation Mode Up: Inquiry Subprograms Previous: Inquire Library Modes

Inquire Menu Characteristics

This Subprogram allows the characteristics of the specified Menu to be determined.

Short Name Calling Sequence

STATUS = UIIQME(MENUID,MENTYP[,MAXBUT])

Long Name Calling Sequence

STATUS = UI_INQUIRE_MENU(...)

Input Arguments

MENUID (Integer) Menu ID

Output Arguments

MENTYP (Integer) Menu Type MAXBUT (Integer) Maximum Button No. (Opt)

Function Value

UI__SUCCESS ) Success UISUCC )

UI__NOT_INITIALIZED ) Package not Initialized UININI )

Note:

  1. The MENTYP Output Parameter can take the following values:-

    UIMENUNONE ) Non-existent Menu UINONE )

    UIMENUACTION ) Action Menu UIACTN )

    UIMENUSELECT ) Select Menu UISELC )

    UIMENUTOGGLE ) Toggle Menu UITOGG )

    UIMENUMIXED ) Value (Mixed) Menu UIMIXD )

    UIMENUTEXT ) Text Menu UITEXT )

    Where these parameters are defined in the UIPACK Parameter Include files (see Appendix B).

  2. The MAXBUT Argument is optional and, if present, will be set to the largest Button ID defined for the specified Menu.


Liz Buckle
Fri Jan 13 17:30:40 CST 1995