API Component.FindChild: Difference between revisions
No edit summary |
XML Import to change Variable types into Variable Types |
||
| Line 10: | Line 10: | ||
==Parameters== | ==Parameters== | ||
[[Variable | [[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 | [[Variable Types|STRING]] ''ChildName'' | ||
:Name of the child to search for | :Name of the child to search for | ||
==Return value== | ==Return value== | ||
[[Variable | [[Variable Types|HANDLE]] | ||
A handle to the child of ''Current'' whose name matches ''ChildName'' | A handle to the child of ''Current'' whose name matches ''ChildName'' | ||
Revision as of 11:08, 10 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 information