List.remove Function

Format

b = list_name.remove(index);

Description

The List.remove function removes the value at the position in the List referenced by the numeric expression index. List index values are one-based, so the index must be between 1 and the length of the List.

Return Value

The function returns a logical value of 1 (true) if the value is successfully removed, and 0 (false) otherwise, which indicates that the index is not valid. If the List is read-only, the function returns default.

Example

List string eligible_heads;

// ...

numeric eligible_head_index = eligible_heads.show("Select the head");

if eligible_head_index <> 0 and eligible_heads.length() > 1 then

eligible_heads.remove(eligible_head_index);

numeric secondary_head_index = eligible_heads.show("Select someone who could also be a head");

endif;