API Component.GetChildHead: Difference between revisions
XML import of API auto-gen |
m Text replacement - "width="90%" style="background-color:#D8C9D8; color:#4B008D;"" to "width="90%" class="mtx-class-macrohead"" |
||
| (18 intermediate revisions by 4 users not shown) | |||
| Line 1: | Line 1: | ||
{| class="mtx-class-macrotable wikitable" | |||
== | |- | ||
| 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 | |||
|- | |||
|- | |||
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE | |||
| width="90%" | Current | |||
|- | |||
| colspan="2" | The component to find the child of | |||
|- | |||
| 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'' | |||
|} | |||
== | ==Detailed description== | ||
For a more detailed description see the [[Component Tree|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 | * Declare a variable 'result' of type HANDLE | ||
* Add to a calculation icon: result = ::Component.GetChildHead(current) | * Add to a calculation icon: <pre class="brush:[cpp]">result = ::Component.GetChildHead(current)</pre> | ||
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)