Difference between revisions of "API Component.Property.GetListItem"
From Flowcode Help
Jump to navigationJump to search (XML import API auto-gen) |
(XML import) |
||
| Line 2: | Line 2: | ||
Gets a single list entry from a property by named index | Gets a single list entry from a property by named index | ||
| + | <div style="width:25%; float:right" class="toc"> | ||
| + | ===Class hierarchy=== | ||
| + | :Component | ||
| + | ::Property | ||
| + | :::GetListItem | ||
| + | </div> | ||
| + | __TOC__ | ||
| − | + | ==Parameters== | |
''[[Variable types|HANDLE]] Handle'' | ''[[Variable types|HANDLE]] Handle'' | ||
:The component handle to get the property of | :The component handle to get the property of | ||
| Line 13: | Line 20: | ||
:The text or integer entry of the property | :The text or integer entry of the property | ||
| − | + | ==Return value== | |
[[Variable types|STRING]] | [[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 | ||
| − | + | ==Detailed description== | |
''No additional information'' | ''No additional information'' | ||
| − | + | ==Examples== | |
| − | + | ===Calling in a calculation=== | |
* Declare a variable 'result' of type STRING | * Declare a variable 'result' of type STRING | ||
| − | * Add to a calculation icon: <pre class="brush:[ | + | * Add to a calculation icon: <pre class="brush:[cpp]">result = ::Component.Property.GetListItem(handle, "property", "index")</pre> |
Revision as of 15:27, 11 May 2013
<sidebar>API contents</sidebar> Gets a single list entry from a property by named index
Class hierarchy
- Component
- Property
- GetListItem
- Property
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
No additional information
Examples
Calling in a calculation
- Declare a variable 'result' of type STRING
- Add to a calculation icon:
result = ::Component.Property.GetListItem(handle, "property", "index")
