Method XbpClipBoard():registerFormat() Foundation

Registers a user-defined data format

Syntax
:registerFormat( <cFormatName> ) --> nFormatID
Parameters
<cFormatName>
<cFormatName> is a character string representing the user-defined name for the clipboard format to register, e.g. "Xbase++ Data". The name of the data format is case-insensitive.
Return

The method returns the ID of the registered data format as a numeric value.

Description

The task of :registerFormat() is to register a user-defined data format in the clipboard. The return value is a numeric ID that must be used together with :setBuffer() and :getBuffer()to store/retrieve corresponding data in/from the clipboard.

Feedback

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.