Jump to content

API Component.GetChildHead: Difference between revisions

From Flowcode Help
Admin (talk | contribs)
XML import
m Text replacement - "width="90%" style="background-color:#D8C9D8; color:#4B008D;"" to "width="90%" class="mtx-class-macrohead""
 
(11 intermediate revisions by 4 users not shown)
Line 1: Line 1:
<sidebar>API contents</sidebar>
{| class="mtx-class-macrotable wikitable"
Gets the first (eldest) child of the component
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''GetChildHead'''
|-
| colspan="2" | Gets the first (eldest) child of the component&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
| width="90%" | Current
|-
| colspan="2" | The component to find the child of&nbsp;
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-h32-icon.png]] - HANDLE
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}


<div style="width:25%; float:right" class="toc">
====Class hierarchy====
[[API Component|Component]]
:[[API Component|GetChildHead]]
</div>
__TOC__


==Parameters==
==Detailed description==
[[Variable types|HANDLE]] ''Current''
For a more detailed description see the [[Component Tree|component tree]].
:The component to find the child of
:''The default value for this parameter is: '''''this'''




==Return value==
This call will return 0 if the ''Handle'' has no child objects.
[[Variable types|HANDLE]]


Returns the first (eldest) child of the component
==Detailed description==
''<span style="color:red;">No additional information</span>''




Line 29: Line 29:
* Declare a variable 'result' of type HANDLE
* Declare a variable 'result' of type HANDLE
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Component.GetChildHead(current)</pre>
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Component.GetChildHead(current)</pre>
''<span style="color:red;">No additional information</span>''

Latest revision as of 14:11, 13 July 2026

GetChildHead
Gets the first (eldest) child of the component 
- HANDLE Current
The component to find the child of 
- HANDLE Return


Detailed description

For a more detailed description see the component tree.


This call will return 0 if the Handle has no child objects.


Examples

Calling in a calculation

  • Declare a variable 'result' of type HANDLE
  • Add to a calculation icon:
    result = ::Component.GetChildHead(current)