Inside Macintosh: OpenDoc Class Reference /

Part 1 - Classes and Methods / ODDraft

AcquireFrame

The AcquireFrame method returns a reference to the frame whose data is stored in the specified storage unit.

ODFrame AcquireFrame (in ODStorageUnitID id);

id

The storage-unit ID for the target frame.

return value

A reference to the specified frame object.

DISCUSSION

This method increments the reference count of the returned frame. When you have finished using that frame, you should call its Release method.

EXCEPTIONS

kODErrCannotAcquireFrame

Cannot access the target frame object.

kODErrIllegalNullIDInput

The id parameter is null.

SEE ALSO

The ODStorageUnitID type (page 903).
The ODDraft::CreateFrame method (page 164).
The ODFrame class (page 294).
"Storing and Retrieving Embedded Frames" on page 302 in OpenDoc Programmer's Guide.
"Adding an Embedded Part" on page 305 in OpenDoc Programmer's Guide.
"Incorporating Intrinsic Content" on page 344 in OpenDoc Programmer's Guide.
"Embedding a Single Part" on page 347 in OpenDoc Programmer's Guide.
Table 11-1 on page 466 in OpenDoc Programmer's Guide.
"Lazy Internalization" on page 473 in OpenDoc Programmer's Guide.

Main | Top of Section | What's New | Apple Computer, Inc. | Find It | Feedback | Help