GetMenuBarAttribute
- Updated2023-02-21
- 2 minute(s) read
GetMenuBarAttribute
int GetMenuBarAttribute (int menuBarHandle, int menuOrMenuItemID, int menuBarAttribute, void *attributeValue);
Purpose
This function returns the value of the specified menu bar attribute.
Parameters
| Input | ||
| Name | Type | Description |
| menuBarHandle | int | Specifier for a particular menu bar that is currently in memory. You can obtain
this handle from functions such as LoadMenuBar and NewMenuBar. If the menu bar was automatically loaded through LoadPanel, use GetPanelMenuBar to get the menu bar handle. |
| menuOrMenuItemID | int | ID that you assigned to the menu or menu item in the User Interface Editor or that you obtain from functions such as NewMenu and NewSubMenu. If the attribute corresponds to the entire menu bar, pass 0 as this parameter. |
| menuBarAttribute | int | The menu bar 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 text is shown for each attribute. To select an attribute, double-click it or select it and then press <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>. The Attribute Values dialog box displays the values and value help for the constants. |
| Output | ||
| Name | Type | Description |
| attributeValue | void * | The value of the specified menu bar attribute. The data type for this parameter depends on the data type of the attribute you specify for the menuBarAttribute parameter. Pass the address of a variable of the same data type of the attribute you pass to menuBarAttribute. 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 3.0 and later
Examples
Refer to the following examples that use the GetMenuBarAttribute function:
- apps\uirview\uirview.cws
Open example - userint\custctrl\toolbar\tooldemo.cws
Open example