GetIDFromStorageUnitRef

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

GetIDFromStorageUnitRef
The GetIDFromStorageUnitRef method returns the storage-unit ID of a referenced storage unit.
ODStorageUnitID GetIDFromStorageUnitRef (
                                 in ODStorageUnitRef aRef);
aRef
A persistent storage-unit reference.
return value
The storage-unit ID the storage unit referenced by the aRef parameter.

DISCUSSION
The focused value must be the same value that created the specified persistent reference. This method looks up the storage unit referenced by the specified persistent reference and returns its storage-unit ID.

EXCEPTIONS

kODErrInvalidStorageUnitRef
The specified persistent reference is not valid.
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 ODStorageUnitID type (page 903).
The ODStorageUnitRef type (page 903).
The ODStorageUnitView::GetID method (page 736).