Difference between revisions of "API Component.GetNext"

From Flowcode Help
Jump to navigationJump to search
(XML import)
 
(3 intermediate revisions by the same user not shown)
Line 1: Line 1:
<sidebar>API contents</sidebar>
+
<sidebar>API Contents</sidebar>
 
Gets the next (younger) sibling of the components handle
 
Gets the next (younger) sibling of the components handle
  
Line 10: Line 10:
  
 
==Parameters==
 
==Parameters==
[[Variable types|HANDLE]] ''Handle''
+
[[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'''
Line 16: Line 16:
  
 
==Return value==
 
==Return value==
[[Variable types|HANDLE]]
+
[[Variable Types|HANDLE]]
  
 
Returns the next (younger) sibling of the components handle
 
Returns the next (younger) sibling of the components handle
Line 33: Line 33:
 
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Component.GetNext(handle)</pre>
 
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Component.GetNext(handle)</pre>
  
''<span style="color:red;">No additional information</span>''
+
''<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

Class hierarchy

Component

GetNext

Parameters

HANDLE Handle

The component to find the sibling of
The default value for this parameter is: this


Return value

HANDLE

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