GetTreeCellRingIndexFromValue
int GetTreeCellRingIndexFromValue (int panelHandle, int controlID, int itemIndex, int columnIndex, int beginningRingIndex, int *index, char value[]);
Purpose
Searches the list of values of a specified ring or combo box cell of a tree control and returns the index of the first item in the list with a value matching the specified value.
This function returns the index –1 if the value is not found.
Supported Controls
You can use GetTreeCellRingIndexFromValue 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. |
| itemIndex | int | Zero-based index of the tree item containing the cell in which you want to search. |
| columnIndex | int | Zero-based index of the tree column that contains the cell in which you want to search. |
| beginningRingIndex | int | The zero-based index specifying the first item the function searches. |
| value | char [] | The value you want to locate in the list. The comparison is case-sensitive. |
| Output | ||
| Name | Type | Description |
| index | int | The zero-based index of the item matching the specified value. Returns –1 if no match is found. |
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 2009 and later