GoFiler Legato Script Reference   Legato v 1.5d Application v 5.25a

Table of Contents	< < Previous	Next >>

 

Chapter Fifteen — Windows/OS Functions (continued)

ClipboardGetUnicode Function

Overview

The ClipboardGetUnicode function retrieves Unicode text from the clipboard, if available.

Syntax/Parameters

Syntax

string = ClipboardGetUnicode ( [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 Unicode text on the clipboard or empty string on failure. Use the GetLastError function to retrieve error information.

Remarks

The ClipboardGetUnicode 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 ClipboardGetUnicode function returns an empty string it could mean that an application posted an empty data to the clipboard.

When text is posted on the clipboard, the operating system will generally create a Unicode copy of the data.

Related Functions

ClipboardGetCSVData — Gets CSV from the clipboard in the form of a string table.

ClipboardGetCSVText — Gets CSV from the clipboard as a raw text string.

ClipboardGetHTML — Gets raw HTML with control prefix or selected components from the clipboard.

ClipboardGetRTF — Gets RTF data from the clipboard as a string.

ClipboardGetText — Gets plain ANSI text from the clipboard.

ClipboardGetUTF — Gets Unicode Text Format from the clipboard.

ClipboardIsUnicodeAvailable — Tests for Unicode (16-bit) text being available on the clipboard.

ClipboardSetUnicode — Sets Unicode text to the clipboard.

Platform Support

Go13, Go16, GoFiler Complete, GoFiler Corporate, GoFiler, GoFiler Lite, GoXBRL

Legato IDE, Legato Basic

 

Table of Contents	< < Previous	Next >>

GoFiler Legato Script Reference — Generated on 12/16/2024

© 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.