Difference between revisions of "API Component.GetNext"
From Flowcode Help
Jump to navigationJump to search (XML import of API auto-gen) |
(XML import) |
||
(15 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
− | + | <sidebar>API Contents</sidebar> | |
− | + | Gets the next (younger) sibling of the components handle | |
− | + | <div style="width:25%; float:right" class="toc"> | |
− | + | ====Class hierarchy==== | |
+ | [[API Component|Component]] | ||
+ | :[[API Component|GetNext]] | ||
+ | </div> | ||
+ | __TOC__ | ||
− | + | ==Parameters== | |
− | + | [[Variable Types|HANDLE]] ''Handle'' | |
:The component to find the sibling of | :The component to find the sibling of | ||
:''The default value for this parameter is: '''''this''' | :''The default value for this parameter is: '''''this''' | ||
− | + | ||
− | [[Variable | + | ==Return value== |
+ | [[Variable Types|HANDLE]] | ||
Returns the next (younger) sibling of the components handle | Returns the next (younger) sibling of the components handle | ||
− | |||
− | |||
− | ===Examples | + | ==Detailed description== |
− | + | For a more detailed description see the [[Component Tree|component tree]]. | |
+ | |||
+ | |||
+ | This call is the functional opposite to [[API Component.GetLast|GetLast]]. It will return 0 if the ''Handle'' is the youngest. | ||
+ | |||
+ | |||
+ | ==Examples== | ||
+ | ===Calling in a calculation=== | ||
* Declare a variable 'result' of type HANDLE | * Declare a variable 'result' of type HANDLE | ||
− | * Add to a calculation icon: result = ::Component.GetNext(handle) | + | * Add to a calculation icon: <pre class="brush:[cpp]">result = ::Component.GetNext(handle)</pre> |
+ | |||
+ | ''<span style="color:red;">No additional examples</span>'' |
Latest revision as of 15:57, 16 January 2014
<sidebar>API Contents</sidebar> Gets the next (younger) sibling of the components handle
Contents
Parameters
HANDLE Handle
- The component to find the sibling of
- The default value for this parameter is: this
Return value
Returns the next (younger) sibling of the components handle
Detailed description
For a more detailed description see the component tree.
This call is the functional opposite to GetLast. It will return 0 if the Handle is the youngest.
Examples
Calling in a calculation
- Declare a variable 'result' of type HANDLE
- Add to a calculation icon:
result = ::Component.GetNext(handle)
No additional examples