indexKeyStrProp: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
m (Added delim to usage and parameter section.)
 
(5 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{MacroFunction
{{MacroFunction
|name=indexKeyStrProp
|name=indexKeyStrProp
|version=1.3b42
|description=
|description=
Returns the key from the specified [[Macros:string property list|string property list]] at the specified index. The index for the [[Macros:string property list|string property list]] starts at 0.
Returns the key from the specified [[Macros:string property list|string property list]] at the specified index. The index for the [[Macros:string property list|string property list]] starts at 0.


|usage=
|usage=
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
[h: val = indexKeyStrProp(prop, index)]
indexKeyStrProp(proplist, index)
</source>
indexKeyStrProp(proplist, index, delim)
</syntaxhighlight>
'''Parameters'''
{{param|proplist|String property list to extract data from.}}
{{param|index|The numerical index of the element you want returned.}}
{{param|delim|Delimiter between fields (default is ";").}}


|example=
|example=
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
[indexKeyStrProp("a=blah; b=doh; c=meh", 1)]
[indexKeyStrProp("a=blah; b=doh; c=meh", 1)]
</source>
</syntaxhighlight>
Returns "b".
Returns "b".
}}
}}
[[Category:String Property List Function]]
[[Category:String Property List Function]]

Latest revision as of 23:59, 14 November 2024

indexKeyStrProp() Function

Introduced in version 1.3b42
Returns the key from the specified string property list at the specified index. The index for the string property list starts at 0.

Usage

indexKeyStrProp(proplist, index)
indexKeyStrProp(proplist, index, delim)

Parameters

  • proplist - String property list to extract data from.
  • index - The numerical index of the element you want returned.
  • delim - Delimiter between fields (default is ";").

Example

[indexKeyStrProp("a=blah; b=doh; c=meh", 1)]
Returns "b".