Toolbar_GetItemVal

int Toolbar_GetItemVal (ToolbarType toolbar, int position, void *value);

Purpose

Gets the value of an item on the toolbar. LabWindows/CVI returns an error if you call this function on a command button, separator, picture pulldown menu, or move handle.


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 on 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.

Separator, move handle, and picture pulldown menu items have no value.
Output
Name Type Description
value any type (passed by value) The address of the destination of the value of the toolbar item.

The data type of value must match the data type of the item. For text pulldown menus, the value retrieved is the string that appears on the button.

Return Value

Name Type Description
status integer Return value indicating whether the function was successful. A negative number indicates that an error occurred.