Difference between revisions of "API Component.FindChild"

From Flowcode Help
Jump to navigationJump to search
(XML Import to change Variable types into Variable Types)
(XML import)
 
(2 intermediate revisions by the same user not shown)
Line 1: Line 1:
<sidebar>API contents</sidebar>
+
<sidebar>API Contents</sidebar>
 
Finds a named object that is part of the component
 
Finds a named object that is part of the component
  
Line 35: Line 35:
 
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Component.FindChild(current, "childname")</pre>
 
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Component.FindChild(current, "childname")</pre>
  
''<span style="color:red;">No additional information</span>''
+
''<span style="color:red;">No additional examples</span>''

Latest revision as of 15:57, 16 January 2014

<sidebar>API Contents</sidebar> Finds a named object that is part of the component

Class hierarchy

Component

FindChild

Parameters

HANDLE Current

Object to search children of
The default value for this parameter is: this

STRING ChildName

Name of the child to search for


Return value

HANDLE

A handle to the child of Current whose name matches ChildName


Detailed description

This call will search the components owned and in scope for the non-case sensitive ChildName.

This call is unnecessary if 'this' is passed as Current and ChildName is a literal string. In this case it is more efficient to use the constant variable which will point to the child component.


Examples

Calling in a calculation

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

No additional examples