Company Events Academic NI Developer Zone Support Solutions Products & Services Contact NI MyNI

Get Menu Item Info

LabVIEW 8.5 Help
August 2007

NI Part Number:
371361D-01

»View Product Info

Returns the attributes of a menu item or menu bar.

Examples

item tag identifies the item whose attributes you want to return. The default is to return the menu bar attributes.

Use application item tags to return application menu item attributes.
menu reference is the reference to a menu bar in a VI or to a shortcut menu of a control. You can obtain this refnum with the Current VI's Menubar function or with the MenuRef event data field of menu events.
error in describes error conditions that occur before this VI or function runs. The default is no error. If an error occurred before this VI or function runs, the VI or function passes the error in value to error out. This VI or function runs normally only if no error occurred before this VI or function runs. If an error occurs while this VI or function runs, it runs normally and sets its own error status in error out. Use the Simple Error Handler or General Error Handler VIs to display the description of the error code. Use error in and error out to check errors and to specify execution order by wiring error out from one node to error in of the next node.
status is TRUE (X) if an error occurred before this VI or function ran or FALSE (checkmark) to indicate a warning or that no error occurred before this VI or function ran. The default is FALSE.
code is the error or warning code. The default is 0. If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code.
source specifies the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning. The default is an empty string.
submenu tags are the submenu item tags if the item has a submenu.
menu reference out returns menu reference unchanged.
item name is the string that appears in the menu.
If enabled is FALSE, the menu item is grayed out.
error out contains error information. If error in indicates that an error occurred before this VI or function ran, error out contains the same error information. Otherwise, it describes the error status that this VI or function produces. Right-click the error out front panel indicator and select Explain Error from the shortcut menu for more information about the error.
status is TRUE (X) if an error occurred or FALSE (checkmark) to indicate a warning or that no error occurred.
code is the error or warning code. If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code.
source describes the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning.
If checked is TRUE, the menu item has a checkmark next to it.
short cut is the keyboard equivalent of selecting this menu item with a mouse.
If include Shift key? is TRUE, the shortcut includes the <Shift> key, in addition to the shortcut key.
If include Ctrl key? is TRUE, the shortcut includes the <Ctrl> key, in addition to the shortcut key. You can set include Ctrl key? to FALSE only if you select a function key, such as <F1>, <F2>, and so on, as the shortcut key. On Mac OS, the key included is <Command>. On Linux, the key included is <Alt>.
shortcut key describes the key associated with the shortcut.

Examples

Refer to the following VIs for examples of using the Get Menu Item Info function:

  • Menu Selection Demo VI: labview\examples\general\menubars.llb
  • Menu Selection with Events VI: labview\examples\general\uievents.llb

Resources


 

Your Feedback! poor Poor  |  Excellent excellent   Yes No
 Document Quality? 
 Answered Your Question? 
Add Comments 1 2 3 4 5 submit