Difference between revisions of "API Tree.StepNamedNext"

From Flowcode Help
Jump to navigationJump to search
(XML import)
(XML import)
Line 3: Line 3:
  
 
<div style="width:25%; float:right" class="toc">
 
<div style="width:25%; float:right" class="toc">
===Class hierarchy===[[API Tree|Tree]]
+
====Class hierarchy====
 +
[[API Tree|Tree]]
 
:[[API Tree|StepNamedNext]]
 
:[[API Tree|StepNamedNext]]
 
</div>
 
</div>
Line 9: Line 10:
  
 
==Parameters==
 
==Parameters==
''[[Variable types|HANDLE]] Object''
+
[[Variable types|HANDLE]] ''Object''
 
:''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
 
:The object to update with the next found sibling
  
''[[Variable types|STRING]] TargetName''
+
[[Variable types|STRING]] ''TargetName''
 
:The name of the sibling to find
 
:The name of the sibling to find
  
Line 20: Line 21:
  
 
==Detailed description==
 
==Detailed description==
''No additional information''
+
''<span style="color:red;">No additional information</span>''
 +
 
  
 
==Examples==
 
==Examples==
 
===Calling in a calculation===
 
===Calling in a calculation===
 
* Add to a calculation icon: <pre class="brush:[cpp]">::Tree.StepNamedNext(return_object, "targetname")</pre>
 
* Add to a calculation icon: <pre class="brush:[cpp]">::Tree.StepNamedNext(return_object, "targetname")</pre>
 +
 +
''<span style="color:red;">No additional information</span>''

Revision as of 22:10, 11 May 2013

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

Class hierarchy

Tree

StepNamedNext

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

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.StepNamedNext(return_object, "targetname")

No additional information