Difference between revisions of "API Tree.StepChildPath"
From Flowcode Help
Jump to navigationJump to search (XML import) |
(XML import) |
||
| (6 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | <sidebar>API | + | <sidebar>API Contents</sidebar> |
Updates the object to point to the '.' separated named child path | Updates the object to point to the '.' separated named child path | ||
<div style="width:25%; float:right" class="toc"> | <div style="width:25%; float:right" class="toc"> | ||
| − | ===Class hierarchy===[[API Tree|Tree]] | + | ====Class hierarchy==== |
| + | [[API Tree|Tree]] | ||
:[[API Tree|StepChildPath]] | :[[API Tree|StepChildPath]] | ||
</div> | </div> | ||
| Line 9: | Line 10: | ||
==Parameters== | ==Parameters== | ||
| − | + | [[Variable Types|HANDLE]] ''Object'' | |
| + | :The object to update with the found child | ||
:''This parameter is returned back to the caller'' | :''This parameter is returned back to the caller'' | ||
| − | |||
| − | + | [[Variable Types|STRING]] ''ChildPath'' | |
:The '.' separated path to search for | :The '.' separated path to search for | ||
| + | |||
==Return value== | ==Return value== | ||
''This call does not return a value'' | ''This call does not return a value'' | ||
| + | |||
==Detailed description== | ==Detailed description== | ||
| − | ''No additional information'' | + | ''<span style="color:red;">No additional information</span>'' |
| + | |||
==Examples== | ==Examples== | ||
===Calling in a calculation=== | ===Calling in a calculation=== | ||
* Add to a calculation icon: <pre class="brush:[cpp]">::Tree.StepChildPath(return_object, "childpath")</pre> | * Add to a calculation icon: <pre class="brush:[cpp]">::Tree.StepChildPath(return_object, "childpath")</pre> | ||
| + | |||
| + | ''<span style="color:red;">No additional examples</span>'' | ||
Latest revision as of 15:58, 16 January 2014
<sidebar>API Contents</sidebar> Updates the object to point to the '.' separated named child path
Contents
Parameters
HANDLE Object
- The object to update with the found child
- This parameter is returned back to the caller
STRING ChildPath
- The '.' separated path to search for
Return value
This call does not return a value
Detailed description
No additional information
Examples
Calling in a calculation
- Add to a calculation icon:
::Tree.StepChildPath(return_object, "childpath")
No additional examples
