Difference between revisions of "API Tree.CheckParent"

Latest revision as of 11:55, 16 January 2023

	CheckParent
Returns true if the object has a parent, else false if it is the root
- HANDLE	Object
The object to check for a parent
- BOOL	Return

@@ Line 1: / Line 1: @@
-wiki page name
+{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
-==TreeCheckParent==
+|-
+| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''CheckParent'''
+|-
+| colspan="2" | Returns true if the object has a parent, else false if it is the root&nbsp;
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
+| width="90%" | Object
+|-
+| colspan="2" | The object to check for a parent&nbsp;
+|-
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-bool-icon.png]] - BOOL
+| width="90%" style="border-top: 2px solid #000;" | ''Return''
+|}
-Returns true if the object has a parent, else false if it is the root
-----
-===Parameters===
+==Detailed description==
-''[[Variable types|HANDLE]] Object''
-:The object to check for a parent
-===Return value===
-[[Variable types|BOOL]]
-Returns true if the object has a parent, else false if it is the root
-===Detailed description===
+==Examples==
-''No additional information''
+===Calling in a calculation===
-===Examples===
-====Calling in a calculation:====
 * Declare a variable 'result' of type BOOL
-* Add to a calculation icon: result = ::Tree.CheckParent(object)
+* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Tree.CheckParent(object)</pre>