list_peek_head function <BLOC/list.h>

The list_peek_head function peeks at (returns a reference to) the first item from a list. This function can be used to treat a list like a queue.

Syntax

void *
list_peek_head(
	List *list
);

Parameters

A pointer to a List object.

Return value

A reference to the first item. If the list was empty, the function returns NULL.