ListRemoveItem

void ListRemoveItem (ListType list, void *itemDestination, int positionOfItemToRemove);

Purpose

This function removes an item from a list. If itemDestination is not zero (0) then the contents of the item will be copied to itemDestination after the item is removed.

Parameters

Input
Name Type Description
list ListType The list whose specified item will be removed.
itemDestination void * A pointer to where the contents of the specified item should be copied after it is deleted from the list.

Zero (0) may be passed if the item is to be deleted from the list without being copied to another location.
positionOfItemToRemove integer The position of the item to remove. The position may be a number from 1 to the number of items in the list.

To remove the first item in a list, the constant FRONT_OF_LIST may be passed.

To remove the last item in a list, the constant END_OF_LIST may be passed.

Return Value

None.