iterator_first function <BLOC/iterator.h>

The iterator_first function finds the first item in an iterable set. After this call, the iterator will be positioned at the start of the iterable set.

Syntax

void *
iterator_first(
	Iterator *iter
);

Parameters

A pointer to the Iterator object controlling the iteration.

Return value

A reference pointer to the located object.