listFind: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
m (Applied Template:MacroFunction)
Line 1: Line 1:
==Function listFind==
{{MacroFunction
 
|name=listFind
|description=
Returns the index of the first occurrence of a value in a [[Macros:string list|string list]]. If the value is not found then -1 is returned.
Returns the index of the first occurrence of a value in a [[Macros:string list|string list]]. If the value is not found then -1 is returned.


===Usage===
|usage=
<source lang="mtmacro" line>
<source lang="mtmacro" line>
[h: ind = listFind(list, value)]
[h: ind = listFind(list, value)]
Line 11: Line 12:
If delim is not specified then the default value of ',' is used as the value separator in the [[Macros:string list|string list]]
If delim is not specified then the default value of ',' is used as the value separator in the [[Macros:string list|string list]]


===Example===
|examples=
<source lang="mtmacro" line>
<source lang="mtmacro" line>
[r: listFind("This, is, a, test", "is")]
[r: listFind("This, is, a, test", "is")]
Line 26: Line 27:
</source>
</source>
Returns -1
Returns -1
}}
[[Category:String List Function]]

Revision as of 02:48, 9 March 2009

listFind() Function

Returns the index of the first occurrence of a value in a string list. If the value is not found then -1 is returned.

Usage

[h: ind = listFind(list, value)]
[h: ind = listFind(list, value, delim)]

If delim is not specified then the default value of ',' is used as the value separator in the string list

Examples

[r: listFind("This, is, a, test", "is")]

Returns 1

[r: listFind("This: is: a: test", "a", ":")]

Returns 2

[r: listFind("This, is, a, test", "not")]
Returns -1