Difference between revisions of "API Tree.Traverse"

From Flowcode Help
Jump to navigationJump to search
(XML import)
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]]
<div style="width:25%; float:right" class="toc">
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Traverse'''
====Class hierarchy====
+
|-
[[API Tree|Tree]]
+
| colspan="2" | Updates the object to step depth-first through the tree&nbsp;
:[[API Tree|Traverse]]
+
|-
</div>
+
|-
__TOC__
+
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
 
+
| width="90%" | Object
==Parameters==
+
|-
[[Variable Types|HANDLE]] ''Object''
+
| colspan="2" | The object to update with the next object&nbsp;
:The object to update with the next object
+
|-
:''This parameter is returned back to the caller''
+
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
 
+
| width="90%" | Root
[[Variable Types|HANDLE]] ''Root''
+
|-
:An optional root object the traversal will not step above
+
| colspan="2" | An optional root object the traversal will not step above&nbsp;
:''The default value for this parameter is: '''''0'''
+
|-
 
+
| 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''
==Return value==
+
|}
''This call does not return a value''
 
  
  

Revision as of 11:41, 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

No additional information


Examples

Calling in a calculation

  • Add to a calculation icon:
    ::Tree.Traverse(return_object, root)

No additional examples