Difference between revisions of "API Tree.StepRoot"

From Flowcode Help
Jump to navigationJump to search
(XML import of API auto-gen)
(XML import)
Line 2: Line 2:
 
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">
 +
===Class hierarchy===
 +
:Tree
 +
::StepRoot
 +
</div>
 +
__TOC__
  
===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
  
===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''
 
''No additional information''
  
===Examples===
+
==Examples==
====Calling in a calculation====
+
===Calling in a calculation===
* Add to a calculation icon: <pre class="brush:[C]">::Tree.StepRoot(return_object)</pre>
+
* Add to a calculation icon: <pre class="brush:[cpp]">::Tree.StepRoot(return_object)</pre>

Revision as of 20:40, 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)