DeleteListItem
int DeleteListItem (int panelHandle, int controlID, int itemIndex, int numberOfItems);
Purpose
Deletes one or more items from a list starting at itemIndex.
Supported Controls
You can use DeleteListItem with the following 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 first item to delete.
|
||
| numberOfItems | int | Number of items to delete. To delete all items from itemIndex
to the end, enter –1 for numberOfItems. When deleting items from a tree, numberOfItems refers to the number of sibling items to delete starting at itemIndex. |
||
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 3.0 and later
Examples
Refer to the following examples that use the DeleteListItem function:
- apps\uirview\uirview.cws
Open example - userint\GraphAnnotations.cws
Open example - userint\graphlegend.cws
Open example - userint\listbox.cws
Open example - userint\listdelx.cws
Open example - userint\treecopy.cws
Open example