ListGetPtrToItem

void *ListGetPtrToItem (ListType list, int itemPosition);

Purpose

This function returns a pointer to the specified item in the list.

The pointer is only valid until the next operation which modifies the list occurs.

This function is provided for convenience of being able to examine a list item without copying it out of the list.

Parameters

Input
Name Type Description
list ListType The list from which to retrieve a pointer to specified item.
itemPosition integer The position of the item to retrieve a pointer to. The position may be a number from 1 to the number of items in the list.

To get a pointer to the first item in a list, the constant FRONT_OF_LIST may be passed.

To get a pointer to the last item in a list, the constant END_OF_LIST may be passed.

Return Value

Name Type Description
itemPointer void * Returns a pointer directly to the item stored in the list.

The pointer is only valid until the next operation that modifies the list occurs.