Description
Determines the index of the first list element that contains a specified substring.
Returns
Index of the first list element that contains substring . If not found, returns zero.
History
ColdFusion (2018 Release): Introduced named parameters.
Category
Function syntax
ListContains(list, substring [, delimiters, includeEmptyFields ])
See also
ListContainsNoCase, ListFind; Lists in Data types- Developing guide in the Developing ColdFusion Applications
Parameters
Parameter |
Description |
|---|---|
includeEmptyFields |
Optional. Set to yes to include empty values. |
list |
A list or a variable that contains the list. |
substring |
A string or a variable that contains one. The search is case sensitive. |
delimiters |
A string or a variable that contains one. Characters that separate list elements. The default value is comma. If this parameter contains more than one character, ColdFusion processes each occurrence of each character as a delimiter. |
Usage
ColdFusion ignores empty list elements; thus, the list "a,b,c,,,d" has four elements.
Example
<cfscript>
myList="Tokyo,Bangkok,Jakarta,Manila,Bangalore,Shanghai";
WriteOutput(ListContains(myList,"Bangkok") & " | "); // Returns 2 since index of Bangkok is 2
WriteOutput(ListContains(myList,"Singapore")); // Returns 0 since Singapore is not a part of the list
</cfscript>
Output
2 | 0
Sign in to your account