Toolbar_GetItemAttribute

int Toolbar_GetItemAttribute (ToolbarType toolbar, int position, int toolbarItemAttribute, void *attributeValue);

Purpose

Returns the value of a particular toolbar item attribute.

Parameters

Input
Name Type Description
toolbar ToolbarType The specifier for the toolbar that contains the item.

Obtain this handle from the Toolbar_New or Toolbar_Duplicate functions.
position integer The position of the item in the toolbar.

Valid positions are from 1 to the number of items on the toolbar (as returned by Toolbar_GetNumItems). You also can use FRONT_OF_LIST or END_OF_LIST to specify the beginning or the end of the list, respectively.
toolbarItemAttribute integer The toolbar item 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 toolbar item 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.