Difference between revisions of "API Tree.StepNamedIndex"

From Flowcode Help
Jump to navigationJump to search
(XML import)
(XML import)
Line 11: Line 11:
 
==Parameters==
 
==Parameters==
 
[[Variable types|HANDLE]] ''Object''
 
[[Variable types|HANDLE]] ''Object''
 +
:The object to update with the next found sibling
 
:''This parameter is returned back to the caller''
 
:''This parameter is returned back to the caller''
:The object to update with the next found sibling
 
  
 
[[Variable types|STRING]] ''TargetName''
 
[[Variable types|STRING]] ''TargetName''
Line 22: Line 22:
 
==Return value==
 
==Return value==
 
''This call does not return a value''
 
''This call does not return a value''
 +
  
 
==Detailed description==
 
==Detailed description==

Revision as of 01:55, 12 May 2013

<sidebar>API contents</sidebar> Updates the object to point to the Nth next (younger) sibling matching the name

Class hierarchy

Tree

StepNamedIndex

Parameters

HANDLE Object

The object to update with the next found sibling
This parameter is returned back to the caller

STRING TargetName

The name of the sibling to find

LONG Index

The index to find, 0 for the first including this

Return value

This call does not return a value


Detailed description

No additional information


Examples

Calling in a calculation

  • Add to a calculation icon:
    ::Tree.StepNamedIndex(return_object, "targetname", index)

No additional information