Difference between revisions of "API Component.GetNext"

From Flowcode Help
Jump to navigationJump to search
(XML import of API auto-gen)
 
(18 intermediate revisions by 3 users not shown)
Line 1: Line 1:
−
<sidebar>API contents</sidebar>
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
−
Gets the next (younger) sibling of the components handle
+
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetNext'''
 +
|-
 +
| colspan="2" | Gets the next (younger) sibling of the components handle&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
 +
| width="90%" | Handle
 +
|-
 +
| colspan="2" | The component to find the sibling of&nbsp;
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-h32-icon.png]] - HANDLE
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
  
  
−
===Parameters===
+
==Detailed description==
−
''[[Variable types|HANDLE]] Handle''
+
For a more detailed description see the [[Component Tree|component tree]].
−
:The component to find the sibling of
 
−
:''The default value for this parameter is: '''''this'''
 
  
−
===Return value===
 
−
[[Variable types|HANDLE]]
 
  
−
Returns the next (younger) sibling of the components handle
+
This call is the functional opposite to [[API Component.GetLast|GetLast]]. It will return 0 if the ''Handle'' is the youngest.
  
−
===Detailed description===
 
−
''No additional information''
 
  
−
===Examples===
+
==Examples==
−
====Calling in a calculation====
+
===Calling in a calculation===
 
* Declare a variable 'result' of type HANDLE
 
* Declare a variable 'result' of type HANDLE
−
* Add to a calculation icon: <pre class="brush:[C]">result = ::Component.GetNext(handle)</pre>
+
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Component.GetNext(handle)</pre>

Latest revision as of 11:54, 16 January 2023

Fc9-comp-macro.png GetNext
Gets the next (younger) sibling of the components handle 
Fc9-h32-icon.png - HANDLE Handle
The component to find the sibling of 
Fc9-h32-icon.png - HANDLE Return


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)
Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=API_Component.GetNext&oldid=30152"