READ_CLIPBOARD

READ_CLIPBOARD calls GET_CLIPBOARD and writes the returned text string directly to the current edit position. READ_CLIPBOARD is equivalent to the following code fragment:

COPY_TEXT (GET_CLIPBOARD);

READ_CLIPBOARD returns a range containing any text additions. UNSPECIFIED is returned if either the GET_CLIPBOARD or COPY_TEXT operations fail.

READ_CLIPBOARD does not function in NODISPLAY mode. The return value would be 0.

Syntax:

range := READ_CLIPBOARD

Example:

The following example copies the clipboard text to the current edit position and returns a range containing the text additions.

INSERTED$RANGE := READ_CLIPBOARD;

Errors:

TPU$_CLIPBOARDFAIL No data found in clipboard.

TPU$_CLIPBOARDLOCKED Another application locked clipboard.

TPU$_CLIPBOARDNODATA Clipboard contains no format data.

TPU$_REQUIRESWINDOWS Must be in a windowed environment.

TPU$_STRTOOLARGE A string can be up to 65,535 characters.

Related Builtins: