API Component.GetLast: Difference between revisions
No edit summary |
XML Import to change Variable types into Variable Types |
||
| Line 10: | Line 10: | ||
==Parameters== | ==Parameters== | ||
[[Variable | [[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 | [[Variable Types|HANDLE]] | ||
Returns the previous (elder) sibling of the components handle | Returns the previous (elder) sibling of the components handle | ||
Revision as of 11:08, 10 June 2013
<sidebar>API contents</sidebar> Gets the previous (elder) sibling of the components handle
Parameters
HANDLE Handle
- The component to find the sibling of
- The default value for this parameter is: this
Return value
Returns the previous (elder) sibling of the components handle
Detailed description
For a more detailed description see the component tree.
This call is the functional opposite to GetNext. It will return 0 if the Handle is the eldest.
Examples
Calling in a calculation
- Declare a variable 'result' of type HANDLE
- Add to a calculation icon:
result = ::Component.GetLast(handle)
No additional information