DlgListBox.DeleteItem

number DlgListBox.DeleteItem ( 

number ControlID,

number Index )

Description

Deletes an item from a list box control.

Note: This action will only work if called from a screen's events and if the named control is on the current screen.

Parameters

ControlID

(number) The numeric ID of the list box control you want to remove an item from.

Index

(number) The index (line number) of the item to delete from the list box. The first item in the list has an index of 1. You can use an index of -1 to delete all items from the list.

Returns

(number) The number of items in the list box after the item is deleted. If an error occurs, -1 is returned. You can use Application.GetLastError to determine whether this action failed, and why.

ResultVariable

When adding an action with the action editor, you can use this field to specify a variable that the return value will be stored in.

See also:  Related Actions