iterator_create function <BLOC/iterator.h>

The iterator_create function creates an iterator object. All iterators are associated with a specific iterable object, specified when creating the iterator.

Syntax

Iterator *
iterator_create(
	void *iterable
);

Parameters

A pointer to the iterable object. This is any object with an Iterable header.

Return value

A reference pointer to the newly created Iterator object. If the object specified is not an iterable object, NULL is returned.