Back to FabImage Studio website
You are here: Start » Filter Reference » Array Basics » GetArrayElement_OrNil
GetArrayElement_OrNil
Extracts a single element from an array at the specified index; returns NIL if the index is out of range.
| Name | Type | Range | Description | |
|---|---|---|---|---|
 |
inArray | <T>Array | Input array | |
|
inIndex | Integer | 0 -  |
Index within the array |
|
inInverse | Bool | Reversed order in the array | |
 |
outConditionalValue | <T>? | Element from the array | |
The type of this filter is defined using the type variable T which represents any valid type. Read more.
Hints
- If you can guarantee that inIndex will always be in range, use GetArrayElement instead.
- To get the last element of an array use inIndex = 0 and inInverse = True.
Examples
Description of usage of this filter can be found in examples and tutorial: Capsules, HMI Recorder.
|
|
|
inArray = {1, 4, 3, 2, 5} inIndex = 3 |
outValue = 2 |
|
|
|
inArray = {1, 4, 3, 2, 5} inIndex = 5 |
outValue = Nil |
Errors
This filter can throw an exception to report error. Read how to deal with errors here: Error Handling
| Error type | Description |
|---|---|
| DomainError | Negative index in GetArrayElement_OrNil. |
Complexity Level
This filter is available on Basic Complexity Level.
Filter Group
This filters is member of GetArrayElement filter group.
