API Tree.Traverse: Difference between revisions
XML import |
XML import |
||
| Line 11: | Line 11: | ||
==Parameters== | ==Parameters== | ||
[[Variable types|HANDLE]] ''Object'' | [[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'' | [[Variable types|HANDLE]] ''Root'' | ||
| Line 20: | Line 20: | ||
==Return value== | ==Return value== | ||
''This call does not return a value'' | ''This call does not return a value'' | ||
==Detailed description== | ==Detailed description== | ||
Revision as of 01:55, 12 May 2013
<sidebar>API contents</sidebar> Updates the object to step depth-first through the tree
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 information