ListDestroy

InstallShield 2014 ยป InstallScript Language Reference

The ListDestroy function destroys the contents of a list and the list itself. Use this function to remove the string or number list identified in listID.

You should destroy all the lists you create when you no longer need them or at the end of the setup script. When you destroy a list, you free all memory associated with the list.

Note: This function works with both string and number lists. After you destroy a list, do not use that in any list function.

Syntax

ListDestroy ( listID );

Parameters

ListDestroy Parameters

Parameter

Description

listID

Specifies the string or number list to destroy.

Return Values

ListDestroy Return Values

Return Value

Description

0

Indicates that the function successfully destroyed the list, removing it from memory.

< 0

Indicates that the function was unable to destroy the list.

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