API Component.Property.GetListItem: Difference between revisions
XML import |
XML import |
||
| Line 3: | Line 3: | ||
<div style="width:25%; float:right" class="toc"> | <div style="width:25%; float:right" class="toc"> | ||
===Class hierarchy===[[API Component|Component]] | ====Class hierarchy==== | ||
[[API Component|Component]] | |||
:[[API Component.Property|Property]] | :[[API Component.Property|Property]] | ||
::[[API Component.Property|GetListItem]] | ::[[API Component.Property|GetListItem]] | ||
| Line 10: | Line 11: | ||
==Parameters== | ==Parameters== | ||
[[Variable types|HANDLE]] ''Handle'' | |||
:The component handle to get the property of | :The component handle to get the property of | ||
[[Variable types|STRING]] ''Property'' | |||
:The textual name of the property | :The textual name of the property | ||
[[Variable types|STRING]] ''Index'' | |||
:The text or integer entry of the property | :The text or integer entry of the property | ||
| Line 25: | Line 26: | ||
==Detailed description== | ==Detailed description== | ||
''No additional information'' | ''<span style="color:red;">No additional information</span>'' | ||
==Examples== | ==Examples== | ||
| Line 31: | Line 33: | ||
* Declare a variable 'result' of type STRING | * Declare a variable 'result' of type STRING | ||
* 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 information</span>'' | |||
Revision as of 22:07, 11 May 2013
<sidebar>API contents</sidebar> Gets a single list entry from a property by named index
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")
No additional information