API Component.GetNext: Difference between revisions

Latest revision as of 14:11, 13 July 2026

	GetNext
Gets the next (younger) sibling of the components handle
- HANDLE	Handle
The component to find the sibling of
- 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)
```

@@ Line 1: / Line 1: @@
-wiki page name
+{| class="mtx-class-macrotable wikitable"
-Gets the next (younger) sibling of the components handle
+|-
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
+| width="90%" class="mtx-class-macrohead" | '''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
-* Add to a calculation icon: result = ::Component.GetNext(handle)
+* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Component.GetNext(handle)</pre>

SteveT (talk | contribs)

Latest revision as of 14:11, 13 July 2026

Detailed description

Examples

Calling in a calculation