Difference between revisions of "API Component.FindChild"
From Flowcode Help
Jump to navigationJump to search (XML import of API auto-gen) |
|||
| (17 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
| − | + | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | |
| − | Finds a named object that is part of the component | + | |- |
| + | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
| + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''FindChild''' | ||
| + | |- | ||
| + | | colspan="2" | Finds a named object that is part of the component | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE | ||
| + | | width="90%" | Current | ||
| + | |- | ||
| + | | colspan="2" | Object to search children of | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING | ||
| + | | width="90%" | ChildName | ||
| + | |- | ||
| + | | colspan="2" | Name of the child to search for | ||
| + | |- | ||
| + | | 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'' | ||
| + | |} | ||
| − | == | + | ==Detailed description== |
| − | + | This call will search the components owned and in [[Component Tree#Scope|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 | * Declare a variable 'result' of type HANDLE | ||
| − | * Add to a calculation icon: result = ::Component.FindChild(current, "childname") | + | * Add to a calculation icon: <pre class="brush:[cpp]">result = ::Component.FindChild(current, "childname")</pre> |
Latest revision as of 11:54, 16 January 2023
|
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")
