GetTreeItem
int GetTreeItem (int panelHandle, int controlID, int relation, int relativeIndex, int beginIndex, int direction, int stateCriteria, int *item);
Purpose
Searches for an item that is relation to relativeIndex. The search starts at beginIndex and proceeds in the direction specified by direction.
Returns in the item parameter the index of the first item that meets stateCriteria.
Refer to the GetTreeItemFromLabel function reference for an example of how to use this and other tree control functions.
Supported Controls
You can use GetTreeItem 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. | ||||||||||||||||||||||
| relation | int |
Defines the relationship between the relative index and the items to be searched. You can select the following values. VAL_ALL—Search all items regardless of their relationship to the relative item. VAL_SIBLING—Search only items that are siblings of the relative item. VAL_CHILD—Search only items that are children of the relative item. VAL_DESCENDENT—Search all items that are descendents of the relative item. VAL_ANCESTOR—Search all items that are ancestors of the relative item. |
||||||||||||||||||||||
| relativeIndex | int | Zero-based index of the item whose relatives defined by the relation parameter will be searched. | ||||||||||||||||||||||
| beginIndex | int |
Zero-based index of the item where the search begins. If beginIndex does not equal relativeIndex, the item at beginIndex must be related to the item at relativeIndex as specified by relation. Use VAL_FIRST to start at the first item that meets the relation requirement to the relative index. The first ancestor is the parent of the relative item. Use VAL_LAST to start at the last item that meets the relation requirement to the relative index. The last ancestor is the ancestor of the relative item that is on level zero. |
||||||||||||||||||||||
| direction | int |
Defines the direction of the items from beginIndex to search. You can select the following values: VAL_NEXT—Include the items below beginIndex in the search. The exception to this is when relation is VAL_ANCESTOR, in which case next means towards the root. VAL_NEXT_PLUS_SELF—Same as VAL_NEXT, except that the item at beginIndex is included in the search. VAL_PREV—Include the items above beginIndex in the search. The exception to this is when relation is VAL_ANCESTOR, in which case previous means towards the relative index. VAL_PREV_PLUS_SELF—Same as VAL_PREV, except that the item at beginIndex is included in the search. |
||||||||||||||||||||||
| stateCriteria | int |
Defines the state of the searched for item. Use any combination of the following masks to define the state of the searched for item:
For example, if you pass (VAL_SELECTED | VAL_MARKED) the function will search for an item that is selected as well as marked. Pass 0 to count items regardless of their state. |
||||||||||||||||||||||
| Output | ||||||||||||||||||||||||
| Name | Type | Description | ||||||||||||||||||||||
| item | int |
The index of the first item in the tree control that has the specified relationship with the relative index that also meets the requirements of stateCriteria. –1 indicates that no item meets the search requirements. |
||||||||||||||||||||||
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
Example
Refer to apps\uirview\uirview.cws for an example of using the GetTreeItem function.