GetTreeCellRingValueFromIndex
int GetTreeCellRingValueFromIndex (int panelHandle, int controlID, int itemIndex, int columnIndex, int ringIndex, char value[]);
Purpose
Returns the value of a specified item of the list of values of a specified ring or combo box cell of a tree control.
Supported Controls
You can use GetTreeCellRingValueFromIndex 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 from which you want to obtain the value. |
| columnIndex | int | The zero-based index of the tree column containing the cell from which you want to obtain the value. |
| ringIndex | int | The zero-based index of the item in the list of values. |
| Output | ||
| Name | Type | Description |
| value | char [] | Buffer into which the value of the specified item is stored. The number of bytes in this buffer must be at least one byte greater than the value returned by GetTreeCellRingValueLengthFromIndex for this list item. |
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