Difference between revisions of "API Tree.Traverse"

From Flowcode Help
Jump to navigationJump to search
(XML import)
 
(7 intermediate revisions by 3 users not shown)
Line 1: Line 1:
−
<sidebar>API contents</sidebar>
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
−
Updates the object to step depth-first through the tree
+
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Traverse'''
 +
|-
 +
| colspan="2" | Updates the object to step depth-first through the tree&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
 +
| width="90%" | Object
 +
|-
 +
| colspan="2" | The object to update with the next object&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
 +
| width="90%" | Root
 +
|-
 +
| colspan="2" | An optional root object the traversal will not step above&nbsp;
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - NONE
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
  
−
<div style="width:25%; float:right" class="toc">
 
−
====Class hierarchy====
 
−
[[API Tree|Tree]]
 
−
:[[API Tree|Traverse]]
 
−
</div>
 
−
__TOC__
 
  
−
==Parameters==
+
==Detailed description==
−
[[Variable types|HANDLE]] ''Object''
 
−
:''This parameter is returned back to the caller''
 
−
:The object to update with the next object
 
  
−
[[Variable types|HANDLE]] ''Root''
 
−
:An optional root object the traversal will not step above
 
−
:''The default value for this parameter is: '''''0'''
 
−
 
−
==Return value==
 
−
''This call does not return a value''
 
−
 
−
==Detailed description==
 
−
''<span style="color:red;">No additional information</span>''
 
  
  
Line 28: Line 29:
 
===Calling in a calculation===
 
===Calling in a calculation===
 
* Add to a calculation icon: <pre class="brush:[cpp]">::Tree.Traverse(return_object, root)</pre>
 
* Add to a calculation icon: <pre class="brush:[cpp]">::Tree.Traverse(return_object, root)</pre>
−
 
−
''<span style="color:red;">No additional information</span>''
 

Latest revision as of 11:55, 16 January 2023

Fc9-comp-macro.png Traverse
Updates the object to step depth-first through the tree 
Fc9-h32-icon.png - HANDLE Object
The object to update with the next object 
Fc9-h32-icon.png - HANDLE Root
An optional root object the traversal will not step above 
Fc9-void-icon.png - NONE Return


Detailed description

Examples

Calling in a calculation

  • Add to a calculation icon: 
    ::Tree.Traverse(return_object, root)
Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=API_Tree.Traverse&oldid=30276"