API Component.FindChild: Difference between revisions
XML Import to change Variable types into Variable Types |
XML import of updated API docs |
||
| 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 37: | ||
* 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 | ''<span style="color:red;">No additional examples</span>'' | ||
Revision as of 09:58, 17 June 2013
<sidebar>API contents</sidebar>
Finds a named object that is part of the component
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