ListDeleteString

InstallShield 2014 ยป InstallScript Language Reference

The ListDeleteString function removes the current element from the string list you specify in listID.

You can also use the ListGetFirstString and ListGetNextString functions to traverse the list and make any element the current element.

Note: ListCurrentString works only with string lists.

Syntax

ListDeleteString ( listID );

Parameters

ListDeleteString Parameters

Parameter

Description

listID

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

Return Values

ListDeleteString Return Values

Return Value

Description

0

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

< 0

Indicates that the function was unable to delete the current element from a string list.

END_OF_LIST (1)

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

ISERR_LIST_NOSUCHLIST (-501)

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

See Also