CLIPGET

7.8.5, PLBCMP GUI Only

The CLIPGET instruction retrieves information from the system clipboard. If the first operand is a PICT object variable, a picture is loaded from the system clipboard. Otherwise, lines of text are moved to the list of variables. The instruction uses the following format:

Where:

label

Optional. A Program Execution Label.

dest

Required. A previously defined Character String Variable, a list of string variables, or a VARLIST of string variables that receive lines of text from the clipboard. Alternatively, a PICT object variable may be specified to receive a picture from the clipboard.

Flags Affected: EOS, OVER

Note the following:

1. If character variables are used, each character variable or element of a character variable ARRAY receives one line of text from the clipboard.

2. If character variables are used, characters are transferred into the character variable starting at the first character of the variable until the line from the clipboard is exhausted or the Physical Length of the variable is encountered. The Form Pointer is set to one and the Length Pointer is set to the last character moved.

3. If character variables are used and there are more characters in the line from the clipboard than fit in the character variable, the remaining characters are truncated and the OVER flag is set.

4. If character variables are used and the clipboard does not contain character data, or a PICT variable is used and the clipboard does not contain a valid picture, the EOS flag is set.

5. If a PICT object is used and it contains a valid picture (through the execution of a CREATE PICT instruction) and there is a valid picture in the system clipboard, the picture in the PICT object is replaced by the picture contained in the system clipboard. All other properties of the PICT object (size, position, border, etc.) remain the same.

6. If a PICT object is used and it does not contain a valid picture, the PICT object variable is created as if the following instruction was executed:
   
   CREATE      {pict}=1:1:1:1,0
   
   This is effectively creating a one column by one row picture from the clipboard. 

7. The only use at this time is to save it for later replacement to the clipboard or to convert from a standard Windows bitmap to a device independent bitmap.

8. If character variables are used and there are more lines in the clipboard than there are variables to receive them, the OVER flag is set.This instruction is not supported by the PLB Web Server.

See Also: Example Code, CLIPSET, System Interface Instructions