Contents

initIterator

Initializes the iteration context for a collection subclass.

Declaration

virtual bool initIterator(
 void *iterationContext) const = 0;

Parameters

  • iterationContext:

    The iteration context to initialize.

Return Value

true if initialization was successful, false otherwise.

Overview

This pure virtual member function, which subclasses must implement, is called by an OSCollectionIterator object to initialize an iteration context for a collection. The collection object should interpret iterationContext appropriately and initialize its contents to begin an iteration.

This function can be called repeatedly for a given context, whenever the iterator is reset via the OSCollectionIterator::reset function.

See Also

Miscellaneous