Jump to content

API Component.GetChildHead: Difference between revisions

From Flowcode Help
Admin (talk | contribs)
XML import API auto-gen
Admin (talk | contribs)
XML import
Line 2: Line 2:
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===
:Component
::GetChildHead
</div>
__TOC__


===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'''


===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


===Detailed description===
==Detailed description==
''No additional information''
''No additional information''


===Examples===
==Examples==
====Calling in a calculation====
===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:[C]">result = ::Component.GetChildHead(current)</pre>
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Component.GetChildHead(current)</pre>

Revision as of 15:36, 11 May 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

No additional information

Examples

Calling in a calculation

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