LabWindows/CVI

Toolbar_InsertActiveXItem

int Toolbar_InsertActiveXItem (ToolbarType toolbar, int position, int panel, int control, int active, const char *description);

Purpose

Copies an ActiveX control as a new item onto a toolbar.

(Linux) This function is not supported.

Parameters

Input
Name Type Description
toolbar ToolbarType The specifier for the toolbar to add an item to.

Obtain this handle from the Toolbar_New or Toolbar_Duplicate functions.
position int The position on the toolbar where the item is to be inserted.

Valid positions are from 1 to one more than the number of items on the toolbar (as returned by Toolbar_GetNumItems). You may also use FRONT_OF_LIST or END_OF_LIST to specify the beginning or the end of the list, respectively.
panel int The panel which contains the ActiveX control to copy.
control int The control ID of the ActiveX control to copy.
active int Specify a nonzero value or select Yes in the function panel to insert an active item.

Specify 0 or select No in the function panel to insert an inactive item.

An active item appears on the toolbar when the toolbar is displayed, while an inactive item does not. This is useful if you want to keep a large number of items on the toolbar but selectively choose which ones are active in different situations.
description const char * The description of the item. Item descriptions are not normally visible, but they appear when you use the toolbar help.

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: Toolbar

Include file: custctrl\toolbar.h

LabWindows/CVI compatibility: LabWindows/CVI 8.1 and later