GetItemState Method (FLOATMENU, MENU, MENUITEM, SUBMENU)

9.0F, PLBCMP GUI Only

 

The GetItemState method returns the state for a specified menu item in a FLOATMENU, MENU, MENUITEM, or SUBMENU object. The method uses the following format:

 

[label]

{object}.GetItemState

GIVING {return} USING [*Key=]{key}

 

Where:

label

Optional. A Program Execution Label.

object

Required. A FLOATMENU, MENU or SUBMENU object from which the current item state is retrieved.

return

Required. A Numeric Variable that receives the menu item state.

key

Required. A Character String Variable that specifies the run-time name (RUNNAME property) or a Numeric Variable that specifies the zero-based position of the menu item that is accessed.

Flags Affected: OVER, ZERO

Note the following:

  1. The {return} value is the state information for the {key} menu item that was specified. The state value can be interpreted as follows:

    2.  

    Value

    Keyword

    This state indicates that the menu item …

    0xFFFFFFFF

    MFS_END

    specified by {key} was not found.

    0x8

    MFS_CHECKED

    is checked.

    0x4

    MFS_DEFAULT

    is the default.

    0x20

    MFS_DISABLED

    is disabled.

    0x40

    MFS_GRAYED

    is disabled.

    0x0

    MFT_ENABLED

    is enabled and can be selected.

    0x800

    MFS_HILITE

    is highlighted.

     

  2. The ZERO flag is set if the value returned is zero.

  3. The OVER flag is set if the size of the {return} variable is too small for the value being stored.

 

 

See Also: Method Syntax, FLOATMENU, MENU, SUBMENU Methods, MENUITEM Methods

 


PL/B Language Reference GetItemName Method (FLOATMENU, MENU, MENUITEM,SUBMENU) GetItemType Method (FLOATMENU, MENU, MENUITEM, SUBMENU)