listDelete: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
m (Macros:Functions:listDelete moved to listDelete: Moved out of the Macros namespace)
No edit summary
 
(4 intermediate revisions by 3 users not shown)
Line 1: Line 1:
==Function listDelete==
{{MacroFunction
 
|name=listDelete
|version=1.3b42
|description=
Returns a [[Macros:string list|string list]] with the specified item deleted from it. The index for the [[Macros:string list|string list]]  
Returns a [[Macros:string list|string list]] with the specified item deleted from it. The index for the [[Macros:string list|string list]]  


===Usage===
|usage=
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
[h: list = listDelete(list, index)]
listDelete(list, index)
[h: list = listDelete(list, index, delim)]
</syntaxhighlight>
</source>
<syntaxhighlight lang="mtmacro" line>
listDelete(list, index, delim)
</syntaxhighlight>


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===
|example=
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
[r: listDelete("This, is, a, test", 1)]  
[r: listDelete("This, is, a, test", 1)]  
</source>
</syntaxhighlight>
Returns This, a, test
Returns This, a, test
}}
[[Category:String List Function]]

Latest revision as of 17:48, 15 March 2023

listDelete() Function

Introduced in version 1.3b42
Returns a string list with the specified item deleted from it. The index for the string list

Usage

listDelete(list, index)
listDelete(list, index, delim)

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

Example

[r: listDelete("This, is, a, test", 1)]
Returns This, a, test