ListRemoveItem
void ListRemoveItem (ListType list, void *itemDestination, ssize_t 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 | ssize_t | The position of the item to remove. The position can be a number from 1 to the number of items in the list. Positions in the list are one-based. To remove the first item in a list, pass -1 or the constant FRONT_OF_LIST. To remove the last item in a list, pass 0 or the constant END_OF_LIST. |
Return Value
None.
Additional Information
Library: Programmer's Toolbox
Include file: toolbox\toolbox.h
LabWindows/CVI compatibility: LabWindows/CVI 4.0 and later
Examples
Refer to the following examples that use the ListRemoveItem function:
- apps\uirview\uirview.cws
Open example - toolbox\list.cws
Open example - userint\custctrl\pathctrl\simple.cws
Open example