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

Get Menu Selection

LabVIEW 8.5 Help
August 2007

NI Part Number:
371361D-01

»View Product Info

Returns the item tag of the last selected menu item, optionally waiting ms timeout milliseconds.

Note  If you use this function with an Event structure configured to handle the same menu item, the Event structure takes precedence and LabVIEW ignores the Get Menu Selection function. In any given VI, use the Event structure or the Get Menu Selection function.

Examples

menu reference is the reference to a menu bar in a VI. You can obtain this refnum with the Current VI's Menubar function.
ms timeout is the maximum amount of time this function checks for a menu selection. The default is 200 ms. –1 indicates never to time out.
If block menu is TRUE, LabVIEW disables menu tracking after reading an item tag. After you process the menu selection, you must use the Enable Menu Tracking function to enable menu tracking. The default is FALSE.
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.
If timed out is TRUE, a user selection was not made within the time specified by ms timeout.
menu reference out returns menu reference unchanged.
item tag is the menu item that was selected. Wire this value to a Case structure selector terminal to handle the menu selection. When you create a case to handle each menu item, enter application item tags in the case selector label to handle application menu items.
item path describes the position of the item in the menu hierarchy, which is in the format of a list of menu tags separated by a colon (:). For example, if you choose the Open menu item from the File menu, the item path is File:Open.
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.

Examples

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

  • Menu Selection Demo VI: labview\examples\general\menubars.llb
  • Block Menu Demo VI: labview\examples\general\menubars.llb

Resources


 

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