CreateStorageUnitRefIterator

Inside Macintosh: OpenDoc Class Reference /: Part 1 - Classes and Methods / ODStorageUnitView

CreateStorageUnitRefIterator
The CreateStorageUnitRefIterator method creates a storage-unit reference iterator for the focused value.
ODStorageUnitRefIterator CreateStorageUnitRefIterator ();
return value
A reference to a storage-unit reference iterator used to traverse all persistent references in the focused value.

DISCUSSION
You can call this method if you need to perform an operation on all storage-unit references in the focused value.
While you are using the returned storage-unit reference iterator, you must not modify the focused value; in particular, you must not call any of the following methods of this storage-unit view: DeleteValue, Internalize, Remove, RemoveStorageUnitRef, SetType, or SetValue. Furthermore, you must not delete the storage unit that created this storage-unit view.
You must delete the returned storage-unit reference iterator when it is no longer needed.

EXCEPTIONS

kODErrUnfocusedStorageUnit
The focus context of this storage-unit view is not a value.
If the storage-unit cursor for this storage-unit view does not represent a legal focus context for the storage unit that created this storage-unit view, this method throws exceptions raised by the FocusWithCursor method of that storage unit.

SEE ALSO
The ODStorageUnitRefIterator class (page 721).
Table 11-1 on page 466 in OpenDoc Programmer's Guide.