Admin Production ni-theme
Current Publication

SetTreeCellRingValueFromIndex

LabWindows/CVI

SetTreeCellRingValueFromIndex

int SetTreeCellRingValueFromIndex (int panelHandle, int controlID, int itemIndex, int columnIndex, int ringIndex);

Purpose

Sets the value of a tree control ring or combo box cell to the specified item of the list of values of the cell.

Supported Controls

You can use SetTreeCellRingValueFromIndex 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 for which you want to set the value.
columnIndex int The zero-based index of the tree column containing the cell for which you want to set the value.
ringIndex int The zero-based index of the item in the list of values.

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