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

From Flowcode Help
Jump to navigationJump to search
(XML import API auto-gen)
(XML import)
Line 2: Line 2:
 
Gets a single lists index value from a property by line number
 
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''
 
''[[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 lists line (first is zero) to read the index of
 
:The lists line (first is zero) to read the index of
  
===Return value===
+
==Return value==
 
[[Variable types|STRING]]
 
[[Variable types|STRING]]
  
 
Returns the single lists index value from a property by line number
 
Returns the single lists index value from a property by line number
  
===Detailed description===
+
==Detailed description==
 
''No additional information''
 
''No additional information''
  
===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: <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>

Revision as of 15:27, 11 May 2013

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

Class hierarchy

Component
Property
GetListIndex

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)