Difference between revisions of "API Component.GetChildHead"

From Flowcode Help
Jump to navigationJump to search
(XML import API changes)
Line 22: Line 22:
  
 
==Detailed description==
 
==Detailed description==
''<span style="color:red;">No additional information</span>''
+
For a more detailed description see the [[Component Tree|component tree]].
 +
 
 +
 
 +
This call will return 0 if the ''Handle'' has no child objects.
 +
 
  
  

Revision as of 09:26, 7 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