Difference between revisions of "API Component.GetChildHead"
From Flowcode Help
Jump to navigationJump to search (XML import of API auto-gen) |
(XML import) |
||
(14 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
− | <sidebar>API | + | <sidebar>API Contents</sidebar> |
Gets the first (eldest) child of the component | Gets the first (eldest) child of the component | ||
+ | <div style="width:25%; float:right" class="toc"> | ||
+ | ====Class hierarchy==== | ||
+ | [[API Component|Component]] | ||
+ | :[[API Component|GetChildHead]] | ||
+ | </div> | ||
+ | __TOC__ | ||
− | + | ==Parameters== | |
− | + | [[Variable Types|HANDLE]] ''Current'' | |
:The component to find the child of | :The component to find the child of | ||
:''The default value for this parameter is: '''''this''' | :''The default value for this parameter is: '''''this''' | ||
− | + | ||
− | [[Variable | + | ==Return value== |
+ | [[Variable Types|HANDLE]] | ||
Returns the first (eldest) child of the component | Returns the first (eldest) child of the component | ||
− | |||
− | |||
− | ===Examples | + | ==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: <pre class="brush:[ | + | * Add to a calculation icon: <pre class="brush:[cpp]">result = ::Component.GetChildHead(current)</pre> |
+ | |||
+ | ''<span style="color:red;">No additional examples</span>'' |
Latest revision as of 15:57, 16 January 2014
<sidebar>API Contents</sidebar> Gets the first (eldest) child of the component
Contents
Parameters
HANDLE Current
- The component to find the child of
- The default value for this parameter is: this
Return value
Returns the first (eldest) child of the component
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)
No additional examples