ListFindItem

InstallShield 2014 ยป InstallScript Language Reference

The ListFindItem function searches for a specific element in a number list, starting at the current element and continuing through the list from that point. If you want to start the search from the beginning of the list, use the ListGetFirstItem function. When ListFindItem finds the element, it becomes the current element in the list.

Note: The ListFindItem function works only with number lists.

Syntax

ListFindItem ( listID, nItem );

Parameters

ListFindItem Parameters

Parameter

Description

listID

Specifies the number list to search.

nItem

Specifies the item to find in the list.

Return Values

ListFindItem Return Values

Return Value

Description

0

The function successfully found the requested element.

< 0

An error prevented the function from searching the specified list. This error occur, for example, if the list specified by listID does not exist.

END_OF_LIST (1)

The function searched to the end of the list and did not find the requested element.

ISERR_LIST_NOSUCHLIST (-501)

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

See Also