API Tree.Traverse: Difference between revisions
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|Traverse]] | :[[API Tree|Traverse]] | ||
</div> | </div> | ||
| Line 9: | Line 10: | ||
==Parameters== | ==Parameters== | ||
[[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 object | :The object to update with the next object | ||
[[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''' | ||
| Line 21: | Line 22: | ||
==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.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>'' | |||
Revision as of 22:10, 11 May 2013
<sidebar>API contents</sidebar> Updates the object to step depth-first through the tree
Parameters
HANDLE Object
- This parameter is returned back to the caller
- The object to update with the next object
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 information