listIndex function

Syntax

• string listIndex(stringList, searchString)

Parameters

1. stringList—string
2. searchString—string

Returns

Returns index of first occurrence of searchString.

Description

The listIndex function returns the index of the first occurrence of the searchString in the stringList or -1 if it is not found. Optional: leading or trailing * in searchString are used as wildcard.

Note:

• Indices are 0 - based.
• Stringlists are a series of strings stored inside one string. The elements are separated by a semicolon (";"). Each item must be followed by a semicolon, also the last one! The data type is "string", thus it is not an array as used in other scripting languages.

Related

• listAdd function
• listClean function
• listCount function
• listFirst function
• listItem function
• listLast function
• listRandom function
• listRange function
• listRemove function
• listRemoveAll function
• listRetainAll function
• listSize function
• listTerminate function

Examples

example.1
    listIndex("rule;your;city;","city")
    # result = 2

example.2
    listIndex("rule;your;city;","*y")
    # result = 2

example.3
    listIndex("rule;your;city;","*y*")
    # result = 1