Difference between revisions of "API Tree.StepNamedIndex"

From Flowcode Help
Jump to navigationJump to search
(XML import API auto-gen)
(XML import of API auto-gen)
Line 22: Line 22:
 
===Examples===
 
===Examples===
 
====Calling in a calculation====
 
====Calling in a calculation====
* Add to a calculation icon: ::Tree.StepNamedIndex(return_object, "targetname", index)
+
* Add to a calculation icon: <pre class="brush:[C]">::Tree.StepNamedIndex(return_object, "targetname", index)</pre>

Revision as of 15:35, 10 May 2013

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


Parameters

HANDLE Object

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

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)