Difference between revisions of "API Tree.StepRoot"

From Flowcode Help
Jump to navigationJump to search
(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|StepRoot]]
 
:[[API Tree|StepRoot]]
 
</div>
 
</div>
Line 9: Line 10:
  
 
==Parameters==
 
==Parameters==
''[[Variable types|HANDLE]] Object''
+
[[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 root of its tree
 
:The object to update with the root of its tree
Line 17: Line 18:
  
 
==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 information</span>''

Revision as of 22:10, 11 May 2013

<sidebar>API contents</sidebar> Updates the object to point to the root of the tree

Class hierarchy

Tree

StepRoot

Parameters

HANDLE Object

This parameter is returned back to the caller
The object to update with the root of its tree

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 information