GetActiveTreeItem
int GetActiveTreeItem (int panelHandle, int controlID, int *activeIndex);
Purpose
Returns the index of the active item of the tree.
Supported Controls
You can use GetActiveTreeItem with tree controls.
Parameters
| Input | ||
| Name | Type | Description |
| panelHandle | int | Specifier for a particular panel that is currently in memory. You can obtain this handle from functions such as LoadPanel and NewPanel. |
| controlID | int | The defined constant, located in the .uir header file, that you assigned to the control in the User Interface Editor, or the ID returned by functions such as NewCtrl and DuplicateCtrl. |
| Output | ||
| Name | Type | Description |
| activeIndex | int |
The zero-based index of the active item. –1 if the tree control has no items. |
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 7.0 and later
Examples
Refer to the following examples that use the GetActiveTreeItem function:
- userint\treecopy.cws
Open example - userint\treeevent.cws
Open example