.CLIENT GET CLIPBOARD

This subroutine gets the current content of the system clipboard.

Usage:

      PASS         <clip_data>                FIELD            SHARE? Y
      PASS         <num_chars>                FIELD            SHARE? Y
      GOSUB    --- .CLIENT GET CLIPBOARD
      *        check for errors
      IF       --- .CLIENT GET CLIPBOARD      NE

Description:

This subroutine gets the current text content of the system clipboard. The first parameter is required, if it is missing the subroutine will CANCEL.

<clip_data> is the data read from the clipboard (Required). This field must be PASSed with Share "Y" to receive the value.

<num_chars> returns the number of characters on the system clipboard (Optional). This field must be PASSed with Share "Y" to receive the value.

If <clip_data> is not large enough to hold the requested number of characters, --- .CLIENT GET CLIPBOARD will contain 'Clipdb chars truncat'.

Note that this can only retrieve text from the clipboard. Other types of data are not supported and will be ignored. Text in the clipboard is pasted character by character into the <clip_data> field. If <clip_data> already contains data and the data in the clipboard is shorter than the data in <clip_data>, the remaining characters in <clip_data> are unchanged.

Comments:

Read what other users have said about this page or add your own comments.

-- JeanNeron - 2012-02-01