Inside Macintosh: OpenDoc Class Reference /

Part 1 - Classes and Methods / ODEmbeddedFramesIterator

First

The First method should begin the iteration and return a reference to the first frame in the iteration sequence.

ODFrame First ();

return value

A reference to the first frame in the iteration sequence, or kODNULL if the part has no embedded frames.

DISCUSSION

A client of this embedded-frames iterator calls this method before calling this embedded-frames iterator's IsNotComplete method for the first time. This method may be called multiple times; each time resets the iteration.

Your override of this method should not increment the reference count of the returned frame object.

OVERRIDING

When you subclass ODEmbeddedFramesIterator, you must override this method. Your override method must not call its inherited method; that is, your override method must implement this method's functionality completely.

EXCEPTIONS

kODErrIteratorOutOfSync

The list of embedded frames for the part was modified while the iteration was in progress.