Determines the index of the first list element that contains a
specified substring.
Returns the index of the first list element that contains
substring. If not found, returns zero.
Lucee Function Reference
Function LISTCONTAINS
Example
listcontains(string list,string substring,[string delimiters,[boolean includeEmptyFields,[boolean multiCharacterDelimiter]]]):number
Arguments
The arguments for this function are set. You can not use other arguments except the following ones.
| Name | Type | Required | Default Value | Description |
|---|---|---|---|---|
| list | string | Yes | a string list | |
| substring | string | Yes | the string to search in the list | |
| delimiters | string | No | , | Characters that separate list elements. The default value is comma. |
| includeEmptyFields | boolean | No | false | if set to true, empty values are included as well |
| multiCharacterDelimiter | boolean | No | false | specifying whether the delimiters parameter specifies a multi-character delimiter. If this parameter is true, the delimiters parameter must specify a single delimiter consisting of multiple characters. This parameter enables the ListToArray function to convert a list such as the following to an array of color names: red:|orange:|yellow:|green:|blue:|indigo:|violet. |