GetCtrlMenuAttribute
int GetCtrlMenuAttribute (int panelHandle, int controlID, int menuItemID, int controlMenuAttribute, void *attributeValue);
Purpose
Returns the value of the specified control menu attribute.
Supported Controls
You can use GetCtrlMenuAttribute with the following controls:
Parameters
| Input | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Name | Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| panelHandle | int | Specifier for a particular panel that is currently in memory. You can obtain this handle from functions such as LoadPanel and NewPanel. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| controlID | int | The defined constant, located in the .uir header file, that you assigned to the control in the User Interface Editor, or the ID returned by functions such as NewCtrl and DuplicateCtrl. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| menuItemID | int | The ID used to reference this menu item. Use a menuItemID you obtained from NewCtrlMenuItem, or use a constant identifying one of the built-in control menu items. The following lists the built-in menu item constants.
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| controlMenuAttribute | int | The control menu attribute value to obtain. In the function panel, when you click the control or press <Enter>, <Spacebar>, or <Ctrl-down arrow>, a dialog box appears containing a hierarchical list of the available attributes. Attributes whose values cannot be obtained are dimmed. Help is shown for each attribute. Select an attribute by double-clicking it or by selecting it and then pressing <Enter>. If the attribute shown in this ring control has named constants as valid values, you can open a list of them by moving to the Attribute Value control and pressing <Enter>. If there is a value shown in the bottom half of the Attribute Value control, the corresponding named constant is marked in the displayed list. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Output | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Name | Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| attributeValue | void * | The value of the specified control menu attribute. The data type for this parameter depends on the data type of the attribute you specify for the controlMenuAttribute parameter. Pass the address of a variable of the same data type of the attribute you pass to controlMenuAttribute. If the attribute shown in this control has named constants as valid values, you can open a list of them by pressing <Enter>. The Attribute Values dialog box displays the values and value help for the constants. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Return Value
| Name | Type | Description |
| status | int | Return value indicating whether the function was successful. A negative number indicates that an error occurred. |
Additional Information
Library: User Interface Library
Include file: userint.h
LabWindows/CVI compatibility: LabWindows/CVI 7.0 and later