WBITMAP-CAPTURE-CLIPBOARD (op-code 9)

This operation saves the current content of the Windows clipboard as an image file. All image types supported by the Microsoft CImage class are also supported by WBITMAP-CAPTURE-CLIPBOARD.

Notes:

If the clipboard is empty or contains an unsupported data type, such as text, an error is returned.
For a list of supported image types, see the Microsoft CImage class documentation.
If you are using this operation in a thin client environment, see Accessing Local Resource Files in the AcuConnect User's Guide for special considerations.

This operation takes only one parameter; the filename to which the clipboard content is saved.

name

This required alphanumeric literal is the name of the file in which the image is saved.

The type of image saved depends on the file extension specified. For example, a file extension of .jpg saves the image as a JPEG file; a file extension of .png saves the image as a PNG file, etc.

The name may include embedded spaces.

The length of this parameter may not exceed 90 characters, including the path; however, this limit might vary on different operating systems.

This parameter is not affected by the FILE_PREFIX configuration variable.

If a file of the specified name already exists, it is overwritten unless it is read-only.