ListRemoveItems
void ListRemoveItems (ListType list, void *itemsDestination, ssize_t firstItemToRemove, ssize_t numberOfItemsToRemove);
Purpose
This function removes a specified number of consecutive items from a list. If itemsDestination is not zero (0) then the contents of the items will be copied to itemsDestination after the items are removed.
Parameters
| Input | ||
| Name | Type | Description |
| list | ListType | The list whose specified items will be removed. |
| itemsDestination | void * | A pointer to where the contents of the specified items will be copied after they are deleted from the list. Zero (0) may be passed if the items are to be deleted from the list without being copied to another location. |
| firstItemToRemove | ssize_t | The position of the first 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 items starting at 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. |
| numberOfItemsToRemove | ssize_t | Specifies the number of items to remove from the list. |
Return Value
None.
Additional Information
Library: Programmer's Toolbox
Include file: toolbox\toolbox.h
LabWindows/CVI compatibility: LabWindows/CVI 4.0 and later