deleteStrProp: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
m (Conversion script moved page deleteStrProp to DeleteStrProp without leaving a redirect: Converting page title to first-letter uppercase)
m (Added delim to usage and added parameter fields.)
 
(4 intermediate revisions by 3 users not shown)
Line 5: Line 5:


|usage=
|usage=
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
deleteStrProp(props, key)
deleteStrProp(proplist, key)
</source>
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=
|example=
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
[r: deleteStrProp("a=blah; b=doh; c=meh", "a")]
[r: deleteStrProp("a=blah; b=doh; c=meh", "a")]
</source>
</syntaxhighlight>
Returns "b=doh; c=meh".
Returns "b=doh; c=meh".
}}
}}
[[Category:String Property List Function]]
[[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")]
Returns "b=doh; c=meh".