Admin Production ni-theme
Current Publication

ListGetItem

LabWindows/CVI

ListGetItem

void ListGetItem (ListType list, void *itemDestination, ssize_t positionOfItemToGet);

Purpose

This function copies the contents of the specified list item to the specified destination. The item remains in the list.

Parameters

Input
Name Type Description
list ListType The list to get the item from.
itemDestination void * A pointer to where ListGetItem should copy the contents of the specified list item.
positionOfItemToGet ssize_t The position of the 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 get 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.

Return Value

None.

Additional Information

Library: Programmer's Toolbox

Include file: toolbox\toolbox.h

LabWindows/CVI compatibility: LabWindows/CVI 4.0 and later