Constant | Description |
---|---|
XBPCLPBRD_TEXT | Data in ASCII text format |
XBPCLPBRD_BITMAP | Graphic data in a bitmap format |
XBPCLPBRD_METAFILE | Graphic data in a meta file format |
nFormat | User-defined format, see :registerFormat() |
Method XbpClipBoard():getBuffer() Foundation
Retrieves the data from the clipboard.
:getBuffer( <nFormat> ) --> xBuffer
The return value depends on the passed parameter:
Constant | Description |
---|---|
XBPCLPBRD_TEXT | Character string |
XBPCLPBRD_BITMAP | XbpBitmap object |
XBPCLPBRD_METAFILE | XbpMetaFile object |
nFormat | User-defined data |
The method :getBuffer() reads data from the clipboard. The desired data format can be specified. The data formats that are currently available in the clipboard are determined using the :queryFormats()method. The clipboard must have been previously opened using the method :open() before the :getBuffer() method is called.
If user-defined data is retrieved from the clipboard, it is automatically converted from its binary storage representation to its original Xbase++ data type using Bin2Var() . This must be taken ito consideration when user-defined data has a complex data type, such as Array or Object. Note that it is an error to attempt to retrieve custom data from the clipboard whose format is not known to the Xbase++ application. If you pass the format identifier of a clipboard format registered by another (ie. non-Xbase++) application, :getBuffer() fails.
If you see anything in the documentation that is not correct, does not match your experience with the particular feature or requires further clarification, please use this form to report a documentation issue.