PblIterator* pblListIterator

( PblList* list )

Returns an iterator over the elements in this list in proper sequence.

Documentation

Returns an iterator over the elements in this list in proper sequence.

The iterator starts the iteration at the beginning of the list.

Note: The memory allocated by this method for the iterator returned needs to be released by calling pblIteratorFree() once the iterator is no longer needed.

The iterators returned by the this method are fail-fast: if the list is structurally modified at any time after the iterator is created, in any way except through the Iterator's own remove or add methods, the iterator will return a PBL_ERROR_CONCURRENT_MODIFICATION error.

Thus, in the face of concurrent modification, the iterator fails quickly and cleanly, rather than risking arbitrary, non-deterministic behavior at an undetermined time in the future.

This method has a time complexity of O(1).

Parameters:

list - The list to create the iterator for

Returns:

void * retptr != NULL: The iterator.
void * retptr == NULL: An error, see pbl_errno:
PBL_ERROR_OUT_OF_MEMORY - Out of memory.
PBL_ERROR_PARAM_LIST - list cannot be iterated.

Alphabetic index