ListFindString

InstallShield 2014 ยป InstallScript Language Reference

The ListFindString function searches for a specified element in a string list, starting at the current element and continuing from that point. If you want to start the search from the beginning of the string list, call the ListGetFirstString function. When ListFindString finds the string, it becomes the current element in the list.

Note: The ListFindString function performs a case-sensitive comparison of the strings, and works only with string lists.

Syntax

ListFindString ( listID, szString );

Parameters

ListFindString Parameters

Parameter

Description

listID

Specifies the string list to search.

szString

Specifies the string to find in the list. InstallShield performs a case-sensitive comparison when searching for this string.

Return Values

ListFindString Return Values

Return Value

Description

0

Indicates that the function successfully found the requested element.

< 0

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

END_OF_LIST (1)

Indicates that InstallShield searched to the end of the list and did not find the requested element.

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