Inside Macintosh: OpenDoc Class Reference /

Part 1 - Classes and Methods / ODClipboard

Clear

The Clear method immediately removes all data stored in this clipboard object.

void Clear ();

DISCUSSION

For thread-safe operation, the active part must acquire the clipboard focus before invoking this method. This method also causes the system clipboard to be cleared, but at a time that is dependent on both the platform and the document shell.

The object calling this method must not be holding a storage-unit reference returned by a prior call to the GetContentStorageUnit method.

After this method executes successfully, the next call to the GetContentStorageUnit method returns a storage-unit object with no properties.

EXCEPTIONS

kODErrBackgroundClipboardClear

This clipboard belongs to a background process.

SEE ALSO

The ODArbitrator::RequestFocus method (page 53).
The ODClipboard::GetContentStorageUnit method (page 92).
"Acquiring and Relinquishing the Clipboard Focus" on page 352 in OpenDoc Programmer's Guide.

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