ListGetFirstItem

InstallShield 2014 ยป InstallScript Language Reference

The ListGetFirstItem function retrieves the first element from a number list. The first item becomes the current element in the list.

Note: The ListGetFirstItem function works only with number lists.

Syntax

ListGetFirstItem ( listID, nvItem );

Parameters

ListGetFirstItem Parameters

Parameter

Description

listID

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

nvItem

Returns the first element of the number list.

Return Values

ListGetFirstItem Return Values

Return Value

Description

0

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

-1

Indicates that an error prevented the function from retrieving the first element in a number 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