User's Guide

REMOVE_FROM_LIST.HELP

Removes an item from a list of items Note: This module was intended for use only by other LAS modules.

Function:

Steps through the LIST, removing all occurances of ITEM.

Parameters:

LIST
List to modify. REMOVE_FROM_LIST will step through the list copying all items that are not the user-specified item to a new list which is then returned to the user.

Example:

  1. list=@the_list item=12

    All occurance of the item '12' are removed from the_list.

Description/Algorithm:

Steps through the LIST, copying all items except the user-specified ITEM to a new_list. If the ITEM is not found in the original LIST a warning message is displayed. Finally, LIST is assigned the contents of the new_list, with all occurances of ITEM removed.

1. [list-warning] ITEM not found in list

    The item specified was not found in the given list. The list was returned unmodified.

Fatal Error Messages:

    None.

User Notes:

    None.