ListDeleteItem

InstallShield 2014 ยป InstallScript Language Reference

The ListDeleteItem function removes the current element from the number list you specify in listID.

You can also use the ListGetFirstItem and ListGetNextItem functions to traverse the list and make any element the current element.

Note: ListDeleteItem works only with numbered lists.

Syntax

ListDeleteItem ( listID );

Parameters

ListDeleteItem Parameters

Parameter

Description

listID

Specifies the number list from which to delete the current element.

Return Values

ListDeleteItem Return Values

Return Value

Description

0

Indicates that the function successfully deleted the current element from a number list.

< 0

Indicates that the list is empty and therefore does not have a current element.

END_OF_LIST (1)

Indicates that the list is empty and therefore does not have a current element.

ISERR_LIST_NOSUCHLIST

Indicates that a list with the specified ID does not exist. Valid list IDs are return values from the ListCreate function.

See Also