listContains: Difference between revisions

Latest revision as of 23:59, 15 March 2023

• Introduced in version 1.3b42

Returns the number of occurrences of a value in a String List.

listContains(list, value)
listContains(list, value, delim)

Parameters

list - The String List that is checked for occurrences of the value.
value - The value to search the String List for occurrences.
delim - The delimiter that separates the values in the String List; defaults to ",".

[r: listContains("a,b,c,a,b,a", "a")]

Returns 3

[h: MyStringList = "1#2#3#4#1#2#3#1#2"]
[r: listContains(MyStringList, "3", "#")]

Returns 2

@@ Line 1: / Line 1: @@
-{{stub}}
 {{MacroFunction
 |name=listContains
+|version=1.3b42
 |description=
-Returns number of occurrences of target in list.
+Returns the number of occurrences of a value in a [[String List]].
 |usage=
-<source lang="mtmacro" line>
+<syntaxhighlight lang="mtmacro" line>
-[h: listContains(list, target) ]
+listContains(list, value)
-</source>
+listContains(list, value, delim)
+</syntaxhighlight>
+'''Parameters'''
+{{param|list|The [[String List]] that is checked for occurrences of the {{code|value}}.}}
+{{param|value|The value to search the [[String List]] for occurrences.}}
+{{param|delim|The delimiter that separates the values in the [[String List]]; defaults to {{code|","}}.}}
+|examples=
+<syntaxhighlight lang="mtmacro" line>
+[r: listContains("a,b,c,a,b,a", "a")]
+</syntaxhighlight>
+Returns {{code|3}}
+<syntaxhighlight lang="mtmacro" line>
+[h: MyStringList = "1#2#3#4#1#2#3#1#2"]
+[r: listContains(MyStringList, "3", "#")]
+</syntaxhighlight>
+Returns {{code|2}}
+|also=
+{{func|listFind}}
 }}
 [[Category:String List Function]]