Difference between revisions of "API Component.Property.GetListItem"
From Flowcode Help
Jump to navigationJump to search (XML import API changes) |
(XML import) |
||
| (5 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | <sidebar>API | + | <sidebar>API Contents</sidebar> |
Gets a single list entry from a property by named index | Gets a single list entry from a property by named index | ||
| Line 11: | Line 11: | ||
==Parameters== | ==Parameters== | ||
| − | [[Variable | + | [[Variable Types|HANDLE]] ''Handle'' |
:The component handle to get the property of | :The component handle to get the property of | ||
| − | [[Variable | + | [[Variable Types|STRING]] ''Property'' |
:The textual name of the property | :The textual name of the property | ||
| − | [[Variable | + | [[Variable Types|STRING]] ''Index'' |
:The text or integer entry of the property | :The text or integer entry of the property | ||
==Return value== | ==Return value== | ||
| − | [[Variable | + | [[Variable Types|STRING]] |
Returns the single list entry from a property by named index | Returns the single list entry from a property by named index | ||
| Line 28: | Line 28: | ||
==Detailed description== | ==Detailed description== | ||
| − | '' | + | Gets the text part of a list property identified by its 3-digit ''Index'. |
| + | |||
| + | |||
| + | Note the ''Index'' is not the line of the list to extract, but the 3-digit identifier. If multiple lines have the same identifier this will extract the first found. | ||
| + | |||
| + | |||
| + | To find the index from the line, use [[API Component.Property.GetListIndex|GetListIndex]]. | ||
| Line 36: | Line 42: | ||
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Component.Property.GetListItem(handle, "property", "index")</pre> | * Add to a calculation icon: <pre class="brush:[cpp]">result = ::Component.Property.GetListItem(handle, "property", "index")</pre> | ||
| − | ''<span style="color:red;">No additional | + | ''<span style="color:red;">No additional examples</span>'' |
Latest revision as of 15:57, 16 January 2014
<sidebar>API Contents</sidebar> Gets a single list entry from a property by named index
Contents
Parameters
HANDLE Handle
- The component handle to get the property of
STRING Property
- The textual name of the property
STRING Index
- The text or integer entry of the property
Return value
Returns the single list entry from a property by named index
Detailed description
Gets the text part of a list property identified by its 3-digit Index'.
Note the Index is not the line of the list to extract, but the 3-digit identifier. If multiple lines have the same identifier this will extract the first found.
To find the index from the line, use GetListIndex.
Examples
Calling in a calculation
- Declare a variable 'result' of type STRING
- Add to a calculation icon:
result = ::Component.Property.GetListItem(handle, "property", "index")
No additional examples
