Info |
---|
AvailabilityThis routine is available starting with SIL Engineā¢ 1.0. |
Table plus |
---|
applyColStyleToCell | true |
---|
heading | 0 |
---|
columnTypes | s,s,s,s |
---|
multiple | false |
---|
columnAttributes | style="background:#e5e7ea;font-weight:bold,,style="background:#e5e7ea;font-weight:bold, |
---|
enableSorting | false |
---|
|
Syntax | arrayGetElement(array, index) | Package | array |
|
...
Alias | getElement(array, index) | Pkg Usage | getElement( |
|
...
Description
Excerpt |
---|
|
Returns the element at the specified index. |
Alias
getElement(array, index)
...
Returns the element at the specified index.
Parameters
Table plus |
---|
applyColStyleToCell | true |
---|
columnTypes | s,s,s,s |
---|
heading | 0 |
---|
multiple | false |
---|
enableSorting | false |
---|
|
Parameter name | Type | Required | Description |
---|
array |
|
...
Array | Yes | Array where the element at the specified index is searched. | index |
|
...
Number | Yes | Index of the element to be returned. |
|
...
Return Type
Element of the array type.
Example
Code Block |
---|
for(number i = 0; i < size(watchers); i = i + 1){
print(getElement(watchers, i) + " is watching this issue.");
}
|
Prints all the elements of the array watchers.
...
Note |
---|
If index is not number or has negative value the routine returns error. If index is greater than the size of the array, the routine will return an empty value of the respective type.
|
...
|
---|
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[0] to refer to the first element in the watchers array. |
See also
Filter by label (Content by label) |
---|
showLabels | false |
---|
max | 10025 |
---|
showSpace | false |
---|
cql | label = "array_routines"routine" and space = currentSpace ( ) |
---|
labels | array_routinesroutine |
---|
|