Difference between revisions of "API Tree.StepNamedNext"
From Flowcode Help
Jump to navigationJump to search (XML import API auto-gen) |
(XML import) |
||
(11 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
− | API | + | <sidebar>API Contents</sidebar> |
Updates the object to point to the next (younger) sibling matching the name | Updates the object to point to the next (younger) sibling matching the name | ||
+ | <div style="width:25%; float:right" class="toc"> | ||
+ | ====Class hierarchy==== | ||
+ | [[API Tree|Tree]] | ||
+ | :[[API Tree|StepNamedNext]] | ||
+ | </div> | ||
+ | __TOC__ | ||
− | + | ==Parameters== | |
− | + | [[Variable Types|HANDLE]] ''Object'' | |
+ | :The object to update with the next found sibling | ||
:''This parameter is returned back to the caller'' | :''This parameter is returned back to the caller'' | ||
− | |||
− | + | [[Variable Types|STRING]] ''TargetName'' | |
:The name of the sibling to find | :The name of the sibling to find | ||
− | + | ||
+ | ==Return value== | ||
''This call does not return a value'' | ''This call does not return a value'' | ||
− | |||
− | |||
− | ===Examples | + | ==Detailed description== |
− | + | ''<span style="color:red;">No additional information</span>'' | |
− | * Add to a calculation icon: ::Tree.StepNamedNext(return_object, "targetname") | + | |
+ | |||
+ | ==Examples== | ||
+ | ===Calling in a calculation=== | ||
+ | * Add to a calculation icon: <pre class="brush:[cpp]">::Tree.StepNamedNext(return_object, "targetname")</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 next (younger) sibling matching the name
Contents
Parameters
HANDLE Object
- The object to update with the next found sibling
- This parameter is returned back to the caller
STRING TargetName
- The name of the sibling to find
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.StepNamedNext(return_object, "targetname")
No additional examples