Difference between revisions of "API Tree.CheckParent"

From Flowcode Help
Jump to navigationJump to search
(XML import of API auto-gen)
(XML import)
Line 2: Line 2:
 
Returns true if the object has a parent, else false if it is the root
 
Returns true if the object has a parent, else false if it is the root
  
 +
<div style="width:25%; float:right" class="toc">
 +
===Class hierarchy===
 +
:Tree
 +
::CheckParent
 +
</div>
 +
__TOC__
  
===Parameters===
+
==Parameters==
 
''[[Variable types|HANDLE]] Object''
 
''[[Variable types|HANDLE]] Object''
 
:The object to check for a parent
 
:The object to check for a parent
  
===Return value===
+
==Return value==
 
[[Variable types|BOOL]]
 
[[Variable types|BOOL]]
  
 
Returns true if the object has a parent, else false if it is the root
 
Returns true if the object has a parent, else false if it is the root
  
===Detailed description===
+
==Detailed description==
 
''No additional information''
 
''No additional information''
  
===Examples===
+
==Examples==
====Calling in a calculation====
+
===Calling in a calculation===
 
* Declare a variable 'result' of type BOOL
 
* Declare a variable 'result' of type BOOL
* Add to a calculation icon: <pre class="brush:[C]">result = ::Tree.CheckParent(object)</pre>
+
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Tree.CheckParent(object)</pre>

Revision as of 21:11, 11 May 2013

<sidebar>API contents</sidebar> Returns true if the object has a parent, else false if it is the root

Class hierarchy

Tree
CheckParent

Parameters

HANDLE Object

The object to check for a parent

Return value

BOOL

Returns true if the object has a parent, else false if it is the root

Detailed description

No additional information

Examples

Calling in a calculation

  • Declare a variable 'result' of type BOOL
  • Add to a calculation icon:
    result = ::Tree.CheckParent(object)