GetItemName Method (FLOATMENU, MENU, MENUITEM, SUBMENU)

PLBCMP GUI Only

 

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

 

[label]

{object}.GetItemName

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

 

Where:

label

Optional. A Program Execution Label.

object

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

return

Required. A Character String Variable that receives the menu item' name.

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: EOS, OVER, ZERO

Note the following:

  1. The {return} variable receives the menu item's name. If there is no text set for a menu item, {return} is set to NULL.

  2. The OVER and ZERO flags are always cleared.

  3. The EOS flag is set if the returned text string is truncated when the character string variable is too small.

 

 

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

 


PL/B Language Reference GetItemCount Method (FLOATMENU, MENU, MENUITEM, SUBMENU) GetItemState Method (FLOATMENU, MENU, SUBMENU)