deleteStrProp: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
Full Bleed (talk | contribs) m (Added delim to usage and added parameter fields.) |
||
(8 intermediate revisions by 4 users not shown) | |||
Line 1: | Line 1: | ||
= | {{MacroFunction | ||
Returns a copy of the [[Macros:string property list|string property list]] with the specified key removed. | |name=deleteStrProp | ||
|version=1.3b42 | |||
|description=Returns a copy of the [[Macros:string property list|string property list]] with the specified key removed. | |||
|usage= | |||
< | <syntaxhighlight lang="mtmacro" line> | ||
deleteStrProp(proplist, key) | |||
</ | deleteStrProp(proplist, key, delim) | ||
</syntaxhighlight> | |||
'''Parameters''' | |||
{{param|proplist|String property list to extract data from.}} | |||
{{param|key|Key within string to extract. This cannot include a space.}} | |||
{{param|delim|Delimiter between fields (default is ";").}} | |||
|example= | |||
< | <syntaxhighlight lang="mtmacro" line> | ||
[r: deleteStrProp("a=blah; b=doh; c=meh", "a")] | [r: deleteStrProp("a=blah; b=doh; c=meh", "a")] | ||
</ | </syntaxhighlight> | ||
Returns "b=doh; c=meh". | Returns "b=doh; c=meh". | ||
}} | |||
[[Category:String Property List Function]] |
Latest revision as of 23:59, 14 November 2024
deleteStrProp() Function
• Introduced in version 1.3b42
Returns a copy of the string property list with the specified key removed.
Usage
deleteStrProp(proplist, key)
deleteStrProp(proplist, key, delim)
Parameters
proplist
- String property list to extract data from.key
- Key within string to extract. This cannot include a space.delim
- Delimiter between fields (default is ";").
Example
[r: deleteStrProp("a=blah; b=doh; c=meh", "a")]