Difference between revisions of "API Component.Property.GetListIndex"

From Flowcode Help
Jump to navigationJump to search
(XML import)
(XML import API auto-gen)
Line 1: Line 1:
The start line of the article
+
<sidebar>API contents</sidebar>
==Component.PropertyGetListIndex==
+
Gets a single lists index value from a property by line number
  
Gets a single lists index value from a property by line number
 
----
 
  
 
===Parameters===
 
===Parameters===
Line 24: Line 22:
  
 
===Examples===
 
===Examples===
====Calling in a calculation:====
+
====Calling in a calculation====
 
* Declare a variable 'result' of type STRING
 
* Declare a variable 'result' of type STRING
* Add to a calculation icon: result = ::Component.Property.GetListIndex(handle, "property", lineix)
+
* Add to a calculation icon: <pre class="brush:[C]">result = ::Component.Property.GetListIndex(handle, "property", lineix)</pre>

Revision as of 15:44, 10 May 2013

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


Parameters

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

Return value

STRING

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

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.GetListIndex(handle, "property", lineix)