Admin Production ni-theme
Current Publication

ListGetItems

LabWindows/CVI

ListGetItems

void ListGetItems (ListType list, void *itemsDestination, ssize_t positionOfFirstItemToGet, ssize_t numberOfItemsToGet);

Purpose

This function copies the contents of the specified list items to the specified destination. The items remain in the list.

Parameters

Input
Name Type Description
list ListType The list to get the items from.
itemsDestination void * A pointer to where ListGetItem should copy the contents of the specified list items. The contents numberOfItemsToGet items are returned, starting with the item specified by positionOfFirstItemToGet.
positionOfFirstItemToGet ssize_t The position of the first item to retrieve. The position can be a number from 1 to the number of items in the list. Positions in the list are one-based.

To start from the first item in the list, pass -1 or the constant FRONT_OF_LIST.

To get the last item in the list, pass 0 or the constant END_OF_LIST.
numberOfItemsToGet ssize_t Specifies the number of items to retrieve.

Return Value

None.

Additional Information

Library: Programmer's Toolbox

Include file: toolbox\toolbox.h

LabWindows/CVI compatibility: LabWindows/CVI 4.0 and later