ListGetFirst

Syntax

POINTER = ListGetFirst(list as POINTER)

Description

Retrieves the head node in a linked list.

Parameters

list - A list created by the ListCreate function.

Return value

The first node of the linked list or NULL if no nodes exist.

Remarks

The returned node can subsequently be used in the ListGetData and ListGetNext functions.

See Also: ListGetData, ListGetNext, ListCreate

Example usage

pos = ListGetFirst(mylist)
WHILE pos <> 0
     data = ListGetData(pos)
     PRINT #<INT>data,
     pos = ListGetNext(pos)
ENDWHILE