ArraySet()
In an one-dimensional array, sets the elements in a specified index range to a value.
Useful for initializing an array after a call to ArrayNew.
ArraySet( array=array, start_pos=number, end_pos=number, value=any );
Returns: Boolean
| Argument | Description |
|---|---|
|
array
array,
required
|
edit
Name of an array. |
|
start_pos
number,
required
|
edit
Starting index position of range to set. Alias: start, startPos |
|
end_pos
number,
required
|
edit
Ending index position of range to set. If this value is greater than array length, Lucee adds elements to array. Alias: end, endPos |
|
value
any,
required
|
edit
Value to which to set each element in the range. |
Examples
editSets a range of array positions to a value
newArray = arrayNew(1);
arraySet(newArray, 1, 4, "All is well");
dump(newArray);
// member function
newArray.set(1,2,"lets change it");
dump(newArray);
See also
- Arrays
- array.set()
- Search Issue Tracker open_in_new
- Search Lucee Test Cases open_in_new (good for further, detailed examples)