Difference between revisions of "API Component.FindChild"
From Flowcode Help
Jump to navigationJump to search (XML import of API auto-gen) |
(XML import) |
||
| (14 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | <sidebar>API | + | <sidebar>API Contents</sidebar> |
Finds a named object that is part of the component | Finds a named object that is part of the component | ||
| + | <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 | :Object to search children of | ||
:''The default value for this parameter is: '''''this''' | :''The default value for this parameter is: '''''this''' | ||
| − | + | [[Variable Types|STRING]] ''ChildName'' | |
:Name of the child to search for | :Name of the child to search for | ||
| − | |||
| − | |||
| − | + | ==Return value== | |
| + | [[Variable Types|HANDLE]] | ||
| − | + | A handle to the child of ''Current'' whose name matches ''ChildName'' | |
| − | '' | ||
| − | ===Examples | + | |
| − | + | ==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: <pre class="brush:[ | + | * Add to a calculation icon: <pre class="brush:[cpp]">result = ::Component.FindChild(current, "childname")</pre> |
| + | |||
| + | ''<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
Contents
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
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
