Inside Macintosh: OpenDoc Class Reference /

Part 1 - Classes and Methods / ODFacetIterator

First

The First method begins the iteration and returns a reference to the first facet in the iteration sequence, as indicated by the traversal type and sibling order that were set for this facet iterator.

ODFacet First ();

return value

A reference to the first facet in the iteration sequence, or kODNULL if the traversal type is children-only and the root facet has no embedded facets.

DISCUSSION

The traversal type and sibling order is set by the facet's CreateFacetIterator method.

Your part must call this method before calling this facet iterator's IsNotComplete method for the first time. This method may be called multiple times; each time resets the iteration.

EXCEPTIONS

kODErrIteratorOutOfSync

The list of embedded facets was modified while the iteration was in progress.

SEE ALSO

The ODFacet::CreateFacetIterator method (page 239).