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

From Flowcode Help
Jump to navigationJump to search
(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|GetListIndex]]
 
::[[API Component.Property|GetListIndex]]
Line 10: Line 11:
  
 
==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
  
''[[Variable types|STRING]] Property''
+
[[Variable types|STRING]] ''Property''
 
:The textual name of the property
 
:The textual name of the property
  
''[[Variable types|ULONG]] LineIx''
+
[[Variable types|ULONG]] ''LineIx''
 
:The lists line (first is zero) to read the index of
 
:The lists line (first is zero) to read the index of
  
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.GetListIndex(handle, "property", lineix)</pre>
 
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Component.Property.GetListIndex(handle, "property", lineix)</pre>
 +
 +
''<span style="color:red;">No additional information</span>''

Revision as of 22:07, 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)

No additional information