API Component.Property.GetListItem: Difference between revisions

Revision as of 15:27, 11 May 2013

<sidebar>API contents</sidebar> Gets a single list entry from a property by named index

Component

Property

GetListItem

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

Returns the single list entry from a property by named index

No additional information

Add to a calculation icon:

result = ::Component.Property.GetListItem(handle, "property", "index")

@@ Line 2: / Line 2: @@
 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===
+==Parameters==
 ''[[Variable types|HANDLE]] Handle''
 :The component handle to get the property of
@@ Line 13: / Line 20: @@
 :The text or integer entry of the property
-===Return value===
+==Return value==
 [[Variable types|STRING]]
 Returns the single list entry from a property by named index
-===Detailed description===
+==Detailed description==
 ''No additional information''
-===Examples===
+==Examples==
-====Calling in a calculation====
+===Calling in a calculation===
 * Declare a variable 'result' of type STRING
-* Add to a calculation icon: <pre class="brush:[C]">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>