GetClipboardImage()

Syntax

Result = GetClipboardImage(#Image [, Depth])

Creates a new image from the clipboard image data (if any).

Parameters

#Image	The number for the new image. #PB_Any can be used to auto-generate this number.
Depth (optional)	The depth of the new image. Valid values are 24 (default) or 32-bit.

Return value

Returns nonzero on success and zero on failure. If #PB_Any was used as the #Image parameter then the new image number is returned.

Remarks

The image may be freed by using the FreeImage() function. For further use of the image, there are functions available such as DrawImage() or ImageGadget().

See Also

GetClipboardText()

Supported OS

All