Availability
This routine is available starting with SIL Engine™ 1.0.
Syntax
arraySetElement(array, index1, elem)
Package
array
Short Name
setElement (only when using package)
Description
If elem is an element of the array type, returns a new array with the specified element on position index1. If index1 is greater than the array size, it will add empty elements on the missing positions.Alias
setElement(array, index1, elem)
Parameters
Parameter name | Type | Required | Description |
|---|---|---|---|
array | array | Yes | Array where to add the element. |
index1 | number | Yes | Position where to add the element. |
elem | type of array element | Yes | Element to add to the array. |
Returns
Element of the array type
Example
watchers = setElement(watchers, 12, currentUser());
Sets the value currentUser for the 13 th element of the array watchers.
Notes
- If array is not defined as an array, the routine returns error.
- If index is not number the routine returns error.
SIL Engine™ 2.5 specific
Starting with version 2.5 we added the indexing operator. It will work on arrays, strings, dates and interval.
You can simply write in your programs watchers[12] = currentUser() to refer to the 13 th element in the watchers array.
See also