Jump to content

API Component.Property.GetListIndex: Difference between revisions

From Flowcode Help
JonnyW (talk | contribs)
XML import API changes
JonnyW (talk | contribs)
XML Import to change Variable types into Variable Types
Line 11: 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




==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

Revision as of 11:08, 10 June 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