Inside Macintosh: OpenDoc Class Reference /

Part 1 - Classes and Methods / ODObjectIterator

First

The First method begins the iteration and obtains the first entry in the name space.

void First (out ODISOStr key, 
            out ODObject object,
            out ODULong objectLength);

key

A pointer to an ISO string representing the key in the first entry in the name space, or kODNULL for an empty name space.

object

A reference to the object in the first entry in the name space.

objectLength

The actual size of the specified object, in bytes.

DISCUSSION

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

It is your responsibility to deallocate the ISO string when it is no longer needed. You must also delete the key when it is no longer needed. You do not need to allocate or deallocate any memory for the object parameter.

EXCEPTIONS

kODErrIteratorOutOfSync

The name space was modified while the iteration was in progress.

SEE ALSO

The ODISOStr type (page 875).