ListGetFirstString

InstallShield 2014 ยป InstallScript Language Reference

The ListGetFirstString function retrieves the first element from a string list. The first string becomes the current element in the list.

The ListGetFirstString function works only with string lists.

Syntax

ListGetFirstString ( listID, svString );

Parameters

ListGetFirstString Parameters

Parameter

Description

listID

Specifies the string list from which to retrieve the first element.

svString

Returns the first element of the string list.

Return Values

ListGetFirstString Return Values

Return Value

Description

0

Indicates that the function successfully retrieved the first element in a string list.

-1

Indicates that an error prevented the function from retrieving the first element in a string list.

END_OF_LIST (1)

Indicates that the list is empty.

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