Difference between revisions of "API Component.GetChildHead"

From Flowcode Help
Jump to navigationJump to search
(XML Import to change Variable types into Variable Types)
Line 10: Line 10:
  
 
==Parameters==
 
==Parameters==
[[Variable types|HANDLE]] ''Current''
+
[[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'''
Line 16: Line 16:
  
 
==Return value==
 
==Return value==
[[Variable types|HANDLE]]
+
[[Variable Types|HANDLE]]
  
 
Returns the first (eldest) child of the component
 
Returns the first (eldest) child of the component

Revision as of 11:08, 10 June 2013

<sidebar>API contents</sidebar> Gets the first (eldest) child of the component

Class hierarchy

Component

GetChildHead

Parameters

HANDLE Current

The component to find the child of
The default value for this parameter is: this


Return value

HANDLE

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 information