GetWeakStorageUnitRef

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

GetWeakStorageUnitRef
The GetWeakStorageUnitRef method creates a weak persistent reference to the specified storage unit.
void GetWeakStorageUnitRef (
                           in ODStorageUnitID embeddedSUID, 
                           out ODStorageUnitRef weakRef);
embeddedSUID
The storage-unit ID of the storage unit whose persistent reference is desired.
weakRef
The persistent reference to the storage unit specified by the embeddedSUID parameter.

DISCUSSION
After this method executes successfully, call the SetValue method to store the resulting persistent reference, returned in the weakRef output parameter, into the focused value.

IMPORTANT
The scope of a persistent reference is limited to the value in which it was created. If you store the persistent reference in a different value, it will almost certainly not refer to the correct storage unit.

EXCEPTIONS

kODErrIllegalNullStorageUnitInput
The embeddedSUID parameter is null.
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::GetStrongStorageUnitRef method (page 743).
The ODStorageUnitView::IsWeakStorageUnitRef method (page 753).
The ODStorageUnitView::SetValue method (page 760).
For more information on persistent references, see the chapter on storage in the OpenDoc Programmer's Guide for the MacOS.