remove
Table of Contents
Overview
The remove() function takes listVariable and indexValue as arguments. It removes the element in the specified indexValue from the list, and returns that element.
Note: Index starts from 0.
Return Type
- Text
Syntax
<variable> = <listVariable>.remove( <indexValue> );
| Parameter | Data type | Description |
|---|---|---|
| <variable> | TEXT | Variable which will contain the returned value. |
| <listVariable> | LIST | The list variable from which the element will be removed and returned. |
| <indexValue> | NUMBER | The index of the element which will be removed from the list, and returned. Value should not be a negative number. If a negative number is specified, a runtime error will be encountered. Value should not exceed the list size. Ideally, this limit will be list size minus 1, since index starts from 0. |
Examples
Product = {"Creator","CRM","Projects"}; element = Product.remove(1); // 'element' variable contains "CRM" info Product; // 'Product' list contains "Creator,Projects"