ListFindItem

int ListFindItem (ListType listToSearch, const void *pointerToItem, int startingPosition, CompareFunction compareFunction);

Purpose

This function searches a list for an item which matches the specified item.

Parameters

Input
Name Type Description
listToSearch ListType The list in which to search for the specified item.
pointerToItem const void * A pointer to the item for which the list will be searched for a matching item.
startingPosition integer The position of the item in the list to start the search from. The position may be a number from 1 to the number of items in the list.

To start searching from the first item in a list, the constant FRONT_OF_LIST may be passed.
compareFunction CompareFunction A comparison function which will be used to compare the specified item to the items in the list.

The compare function should have the following prototype:

int CVICALLBACK CompareFunction(void *item1, void *item2);


The compare function should return a negative number if item1 is less than item2, it should return 0 if item1 is equal to item2, and it should return a positive number is item1 is greater than item2.

If zero (0) is passed for the compare function, the C Library function memcmp will be called to compare items.

This instrument driver provides several commonly useful comparison functions:

ShortCompare
IntCompare
FloatCompare
DoubleCompare
CStringCompare
CStringNoCaseCompare

Return Value

Name Type Description
foundPosition integer Returns the index of the first item in the list at or after the startingPosition whose contents match the specified item.

Zero (0) is returned if no matching item is found in the list.