Difference between revisions of "API Tree.Traverse"
From Flowcode Help
Jump to navigationJump to search (XML import of API auto-gen) |
(XML import) |
||
(9 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
− | <sidebar>API | + | <sidebar>API Contents</sidebar> |
Updates the object to step depth-first through the tree | Updates the object to step depth-first through the tree | ||
+ | <div style="width:25%; float:right" class="toc"> | ||
+ | ====Class hierarchy==== | ||
+ | [[API Tree|Tree]] | ||
+ | :[[API Tree|Traverse]] | ||
+ | </div> | ||
+ | __TOC__ | ||
− | + | ==Parameters== | |
− | + | [[Variable Types|HANDLE]] ''Object'' | |
+ | :The object to update with the next object | ||
:''This parameter is returned back to the caller'' | :''This parameter is returned back to the caller'' | ||
− | |||
− | + | [[Variable Types|HANDLE]] ''Root'' | |
:An optional root object the traversal will not step above | :An optional root object the traversal will not step above | ||
:''The default value for this parameter is: '''''0''' | :''The default value for this parameter is: '''''0''' | ||
− | + | ||
+ | ==Return value== | ||
''This call does not return a value'' | ''This call does not return a value'' | ||
− | |||
− | |||
− | ===Examples | + | ==Detailed description== |
− | + | ''<span style="color:red;">No additional information</span>'' | |
− | * Add to a calculation icon: <pre class="brush:[ | + | |
+ | |||
+ | ==Examples== | ||
+ | ===Calling in a calculation=== | ||
+ | * Add to a calculation icon: <pre class="brush:[cpp]">::Tree.Traverse(return_object, root)</pre> | ||
+ | |||
+ | ''<span style="color:red;">No additional examples</span>'' |
Latest revision as of 15:58, 16 January 2014
<sidebar>API Contents</sidebar> Updates the object to step depth-first through the tree
Contents
Parameters
HANDLE Object
- The object to update with the next object
- This parameter is returned back to the caller
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
No additional information
Examples
Calling in a calculation
- Add to a calculation icon:
::Tree.Traverse(return_object, root)
No additional examples