Admin Production ni-theme
Current Publication

DeleteTreeCellRingItems

LabWindows/CVI

DeleteTreeCellRingItems

int DeleteTreeCellRingItems (int panelHandle, int controlID, int itemIndex, int columnIndex, int ringIndex, int numberOfItems);

Purpose

Deletes one or more items from the list of values of a specified ring or combo box cell of a tree control.

LabWindows/CVI decreases the indexes of the remaining values beyond the specified index by numberOfItems.

Supported Controls

You can use DeleteTreeCellRingItems 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 remove the value(s).
columnIndex int Zero-based index of the tree column that contains the cell from which you want to remove the value(s).
ringIndex int The zero-based index of the first item to delete from the list of values.

numberOfItems int The number of items to delete.

To delete all items from ringIndex to the end of the list of values, enter –1.

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