  |
GoFiler Legato Script Reference
Legato v 1.5d Application v 5.25a
|
| Table of Contents | < < Previous | Next >> |
Chapter Fifteen — Windows/OS Functions (continued)
Overview
The ClipboardGetRTF function retrieves Rich Text Format (RTF) data from the clipboard, if available.
Syntax/Parameters
Syntax
string = ClipboardGetRTF ( [handle hClipboard] );
Parameters
hClipboard
An optional handle specifying an open Clipboard Object. If a handle is not specified, or specified as NULL_HANDLE, the default clipboard is open. If a Clipboard Object is open, it is automatically selected, and, if no object is open, a new object is opened and then closed upon completion of the function.
Return Value
Returns a string containing a copy of the raw RTF data on the clipboard or an empty string on failure. Use the GetLastError function to retrieve error information.
Remarks
The ClipboardGetRTF can return very large strings that may exceed the limit of many string functions. In addition, it can take a significant amount of time for certain applications to render various clipboard formats. Calling this function could result in what appears to be the application hanging while Windows retrieves the data.
Note that if the ClipboardGetRTF function returns an empty string it could mean that an application posted empty data to the clipboard.
Related Functions
Platform Support
Go13, Go16, GoFiler Complete, GoFiler Corporate, GoFiler, GoFiler Lite, GoXBRL
Legato IDE, Legato Basic
| Table of Contents | < < Previous | Next >> |
© 2012-2024 Novaworks, LLC. All rights reserved worldwide. Unauthorized use, duplication or transmission prohibited by law. Portions of the software are protected by US Patents 10,095,672, 10,706,221 and 11,210,456. GoFiler™ and Legato™ are trademarks of Novaworks, LLC. EDGAR® is a federally registered trademark of the U.S. Securities and Exchange Commission. Novaworks is not affiliated with or approved by the U.S. Securities and Exchange Commission. All other trademarks are property of their respective owners. Use of the features specified in this language are subject to terms, conditions and limitations of the Software License Agreement.