Difference between revisions of "API Tree.StepNamedNext"

From Flowcode Help
Jump to navigationJump to search
(XML import of API auto-gen)
(XML import)
Line 2: Line 2:
 
Updates the object to point to the next (younger) sibling matching the name
 
Updates the object to point to the next (younger) sibling matching the name
  
 +
<div style="width:25%; float:right" class="toc">
 +
===Class hierarchy===
 +
:Tree
 +
::StepNamedNext
 +
</div>
 +
__TOC__
  
===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''
Line 11: Line 17:
 
:The name of the sibling to find
 
:The name of the sibling to find
  
===Return value===
+
==Return value==
 
''This call does not return a value''
 
''This call does not return a value''
  
===Detailed description===
+
==Detailed description==
 
''No additional information''
 
''No additional information''
  
===Examples===
+
==Examples==
====Calling in a calculation====
+
===Calling in a calculation===
* Add to a calculation icon: <pre class="brush:[C]">::Tree.StepNamedNext(return_object, "targetname")</pre>
+
* Add to a calculation icon: <pre class="brush:[cpp]">::Tree.StepNamedNext(return_object, "targetname")</pre>

Revision as of 20:38, 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")