Back to Adaptive Vision Studio website
You are here: Start » Filter Reference » Array » Array Composition » InsertToArray
Advanced| Module: | FoundationLite |
|---|
Inserts a new element to an array at a specified location.
| Name | Type | Range | Description | |
|---|---|---|---|---|
| ioArray | <T>Array | |||
 |
inValue | <T> | Input value to be inserted | |
|
inIndex | Integer | 0 -  |
Input index within the inArray at which the inValue will be placed |
|
inInverse | Bool | Determines if the indices are counted from beginning or from end of the input array | |
The type of this filter is defined using the type variable T which represents any valid type. Read more.
Examples
|
 |
|
inArray = {1,2,3,4,5} inIndex = 1 inValue = 10 |
outArray = {1,10,2,3,4,5} |
|
|
|
inArray = {1,2,3,4,5} inIndex = 5 inValue = 10 |
outArray = {1,2,3,4,5,10} |
Errors
This filter can throw an exception to report error. Read how to deal with errors in Error Handling.
List of possible exceptions:
| Error type | Description |
|---|---|
| DomainError | Index out of range in InsertToArray. |
Complexity Level
This filter is available on Advanced Complexity Level.
See Also
- InsertArrayToArray – Inserts an array at the specified index of another array.
- AppendToArray – Inserts a new element at the end of an array.
