API Component.Property.GetListIndex: Difference between revisions

Revision as of 15:27, 11 May 2013

<sidebar>API contents</sidebar> Gets a single lists index value from a property by line number

Component

Property

GetListIndex

HANDLE Handle

The component handle to get the property of

STRING Property

The textual name of the property

ULONG LineIx

The lists line (first is zero) to read the index of

Returns the single lists index value from a property by line number

No additional information

Add to a calculation icon:

result = ::Component.Property.GetListIndex(handle, "property", lineix)

@@ Line 2: / Line 2: @@
 Gets a single lists index value from a property by line number
+<div style="width:25%; float:right" class="toc">
+===Class hierarchy===
+:Component
+::Property
+:::GetListIndex
+</div>
+__TOC__
-===Parameters===
+==Parameters==
 ''[[Variable types|HANDLE]] Handle''
 :The component handle to get the property of
@@ Line 13: / Line 20: @@
 :The lists line (first is zero) to read the index of
-===Return value===
+==Return value==
 [[Variable types|STRING]]
 Returns the single lists index value from a property by line number
-===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.GetListIndex(handle, "property", lineix)</pre>
+* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Component.Property.GetListIndex(handle, "property", lineix)</pre>