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 integer Specifier for a particular menu bar that is currently in memory. You obtain this handle from LoadMenuBar or NewMenuBar.

If the menu bar was automatically loaded through LoadPanel, use GetPanelMenuBar to get the menu bar handle.
menuOrMenuItemID integer ID that you assigned to the menu or menu item in the User Interface Editor or that you obtain from NewMenu, NewSubMenu, or NewMenuItem.

If the attribute corresponds to the entire menu bar, pass 0 as this parameter.
menuBarAttribute integer 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.

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 integer Return value indicating whether the function was successful. A negative number indicates that an error occurred.

Code Error Message String
xx Success