API Component.FindChild: Difference between revisions

Latest revision as of 14:11, 13 July 2026

	FindChild
Finds a named object that is part of the component
- HANDLE	Current
Object to search children of
- STRING	ChildName
Name of the child to search for
- HANDLE	Return

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")

@@ Line 1: / Line 1: @@
-<sidebar>API contents</sidebar>
+{| class="mtx-class-macrotable wikitable"
-Finds a named object that is part of the component
+|-
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
+| width="90%" class="mtx-class-macrohead" | '''FindChild'''
+|-
+| colspan="2" | Finds a named object that is part of the component&nbsp;
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
+| width="90%" | Current
+|-
+| colspan="2" | Object to search children of&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
+| width="90%" | ChildName
+|-
+| colspan="2" | Name of the child to search for&nbsp;
+|-
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-h32-icon.png]] - HANDLE
+| width="90%" style="border-top: 2px solid #000;" | ''Return''
+|}
-<div style="width:25%; float:right" class="toc">
-====Class hierarchy====
-[[API Component|Component]]
-:[[API Component|FindChild]]
-</div>
-__TOC__
-==Parameters==
-[[Variable types|HANDLE]] ''Current''
-:Object to search children of
-:''The default value for this parameter is: '''''this'''
-[[Variable types|STRING]] ''ChildName''
-:Name of the child to search for
+==Detailed description==
+This call will search the components owned and in [[Component Tree#Scope|scope]] for the non-case sensitive ''ChildName''.
-==Return value==
+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.
-[[Variable types|HANDLE]]
-''<span style="color:red;">No additional information</span>''
-==Detailed description==
-''<span style="color:red;">No additional information</span>''
@@ Line 31: / Line 32: @@
 * Declare a variable 'result' of type HANDLE
 * Add to a calculation icon: <pre class="brush:[cpp]">result = ::Component.FindChild(current, "childname")</pre>
-''<span style="color:red;">No additional information</span>''

SteveT (talk | contribs)

Latest revision as of 14:11, 13 July 2026

Detailed description

Examples

Calling in a calculation