GetNumTreeItems
int GetNumTreeItems (int panelHandle, int controlID, int relation, int relativeIndex, int beginIndex, int direction, int stateCriteria, int *count);
Purpose
Counts the number of items that have the specified relation to the relative index. The count starts at beginIndex and proceeds in the specified direction. Counts only those items that meet the stateCriteria.
To get the number of all the items in the tree, use GetNumListItems.
Supported Controls
You can use GetNumTreeItems 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 item and the items to be counted. You can select the following values: VAL_ALL—Count all items regardless of their relationship to the relative item. VAL_SIBLING—Count only items that are siblings of the relative item. VAL_CHILD—Count only items that are children of the relative item. VAL_DESCENDENT—Count all items that are descendents of the relative item. VAL_ANCESTOR—Count all items that are ancestors of the relative item. |
||||||||||||||||||||||
| relativeIndex | int | Identifies the relative of the items to be counted. All items in the specified direction that match the relationship to the relative item will be counted. | ||||||||||||||||||||||
| beginIndex | int |
Zero-based index of the item where the count 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. |
||||||||||||||||||||||
| direction | int |
Defines the direction of the items from beginIndex to count. You can select the following values: VAL_NEXT—Include the items below beginIndex in the count. VAL_NEXT_PLUS_SELF—Include the items below beginIndex, along with the item at beginIndex, in the count. VAL_PREV—Include the items above beginIndex in the count. VAL_PREV_PLUS_SELF—Include the items above beginIndex, along with the item at beginIndex, in the count. |
||||||||||||||||||||||
| stateCriteria | int |
Defines the state of the items to be counted. Use any combination of the following masks to define the state of the items to be counted:
For example, if you pass (VAL_SELECTED | VAL_MARKED) the function will only count items that are selected as well as marked. Pass 0 to count items regardless of their state. |
||||||||||||||||||||||
| Output | ||||||||||||||||||||||||
| Name | Type | Description | ||||||||||||||||||||||
| count | int | The number of items in the tree control that match the specified relationship to the relative index that also meet the requirements of stateCriteria. | ||||||||||||||||||||||
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