Difference between revisions of "API Tree.StepNamedIndex"

From Flowcode Help
Jump to navigationJump to search
(XML import)
(XML Import to change Variable types into Variable Types)
Line 10: Line 10:
  
 
==Parameters==
 
==Parameters==
[[Variable types|HANDLE]] ''Object''
+
[[Variable Types|HANDLE]] ''Object''
 
:The object to update with the next found sibling
 
: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''
  
[[Variable types|STRING]] ''TargetName''
+
[[Variable Types|STRING]] ''TargetName''
 
:The name of the sibling to find
 
:The name of the sibling to find
  
[[Variable types|LONG]] ''Index''
+
[[Variable Types|LONG]] ''Index''
 
:The index to find, 0 for the first including this
 
:The index to find, 0 for the first including this
  

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