| Tag Link | [Array->Remove] | Category | Array |
|---|---|---|---|
| Type | Member | Source Available | No |
| Support | Preferred | Version | 5.0 |
| Change | Unchanged | Data Source | Any |
| Output Type | None | Security | None |
| Implementation | LCAPI | Sets | Lasso 8.5, Lasso 8.0, Lasso 7.0, Lasso 6.0, Lasso 5.0 |
[Array->Remove] removes an item from the array. Accepts a single integer parameter identifying the position of the item to be removed. Defaults to the last item in the array. Returns no value.
The first element in an array is at position 1. An error is returned if the position specified is beyond the size of the array.
Note: The specified element in the array is removed and the positions of all elements in the array above the position are adjusted down by one.
[Array->(Remove: Array Position)]
| Required Parameters | |
|---|---|
| Array Index | The index of the element which should be removed from the array. |
To remove an element from an array:
Use the [Array->Remove] tag. The following example removes the third element, Tue, from an array of the days of the week. The remainder of the array is output.
<?LassoScript
Variable: 'DaysOfWeek'=(Array: 'Sun', 'Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat');
$DaysOfWeek->(Remove: 3);
Output: $DaysOfWeek;
?>
(Array: (Sun), (Mon), (Wed), (Thu), (Fri), (Sat))