Difference between revisions of "API Tree.StepRoot"
From Flowcode Help
Jump to navigationJump to search (XML import) |
(XML import) |
||
| (8 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | <sidebar>API | + | <sidebar>API Contents</sidebar> |
Updates the object to point to the root of the tree | Updates the object to point to the root of the tree | ||
<div style="width:25%; float:right" class="toc"> | <div style="width:25%; float:right" class="toc"> | ||
| − | ===Class hierarchy=== | + | ====Class hierarchy==== |
| − | + | [[API Tree|Tree]] | |
| − | : | + | :[[API Tree|StepRoot]] |
</div> | </div> | ||
__TOC__ | __TOC__ | ||
==Parameters== | ==Parameters== | ||
| − | + | [[Variable Types|HANDLE]] ''Object'' | |
| + | :The object to update with the root of its tree | ||
:''This parameter is returned back to the caller'' | :''This parameter is returned back to the caller'' | ||
| − | + | ||
==Return value== | ==Return value== | ||
''This call does not return a value'' | ''This call does not return a value'' | ||
| + | |||
==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.StepRoot(return_object)</pre> | * Add to a calculation icon: <pre class="brush:[cpp]">::Tree.StepRoot(return_object)</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 point to the root of the tree
Contents
Parameters
HANDLE Object
- The object to update with the root of its tree
- This parameter is returned back to the caller
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.StepRoot(return_object)
No additional examples
