  |
GoFiler Legato Script Reference
Legato v 1.5b Application v 5.24b
|
| Table of Contents | < < Previous | Next >> |
Chapter Fifteen — Windows/OS Functions (continued)
ClipboardGetFormatDescription Function
Overview
The ClipboardGetFormatDescription function retrieves a descriptive string for the associated clipboard format.
Syntax/Parameters
Syntax
string = ClipboardGetFormatDescription ( [handle hClipboard], dword format | string code );
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.
format code
A dword as a clipboard format code or a string representation of a format name or code. See the list of types and codes defined in Section 15.5 Clipboard Functions.
Return Value
Returns a string that contains a descriptive name of the clipboard format or an empty string on error. Use the GetLastError function to retrieve the application code or a formatted error code.
Remarks
ClipboardGetFormatDescription differs from ClipboardGetFormatName in that it is not the registered format name but rather a more human consumable version. Since any format can be defined by any application, the function may return “Not Known” when a translation is not available,
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.