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

From Flowcode Help
Jump to navigationJump to search
(XML import API changes)
(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|STRING]] ''Index''
+
[[Variable Types|STRING]] ''Index''
 
:The text or integer entry of the property
 
:The text or integer entry of the property
  
  
 
==Return value==
 
==Return value==
[[Variable types|STRING]]
+
[[Variable Types|STRING]]
  
 
Returns the single list entry from a property by named index
 
Returns the single list entry from a property by named index

Revision as of 11:08, 10 June 2013

<sidebar>API contents</sidebar> Gets a single list entry from a property by named index

Class hierarchy

Component

Property
GetListItem

Parameters

HANDLE Handle

The component handle to get the property of

STRING Property

The textual name of the property

STRING Index

The text or integer entry of the property


Return value

STRING

Returns the single list entry from a property by named index


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.GetListItem(handle, "property", "index")

No additional information