DeleteListItem

int DeleteListItem (int panelHandle, int controlID, int itemIndex, int numberOfItems);

Purpose

Deletes one or more items from a list control starting at Item Index.

Parameters

Input
Name Type Description
panelHandle integer Specifier for a particular panel that is currently in memory. You obtain this handle from LoadPanel, NewPanel, or DuplicatePanel.
controlID integer 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 NewCtrl or DuplicateCtrl.
itemIndex integer Zero-based index of the first item to delete.
numberOfItems integer 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 integer Return value indicating whether the function was successful. A negative number indicates that an error occurred.

Code Error Message String
xx Success