ListSetCurrentString

InstallShield 2014 ยป InstallScript Language Reference

The ListSetCurrentString function assigns the value of szString to the current element in the string list.

Note: The ListSetCurrentString function works only with string lists.

Syntax

ListSetCurrentString ( listID, szString );

Parameters

ListSetCurrentString Parameters

Parameter

Description

listID

Specifies the name of a string list whose current element is to be updated. The list identified by listID must already have been initialized by a call to ListCreate.

szString

Specifies the string value that will replace the current element.

Return Values

ListSetCurrentString Return Values

Return Value

Description

0

Indicates that the function successfully updated the current element in a number 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.

< 0

Indicates that the function was unable to update the current element in a number list. A common reason for this error is that the index is out of range of available list elements.

See Also