GoFiler Legato Script Reference   Legato v 1.5b Application v 5.24b

Table of Contents	< < Previous	Next >>

 

Chapter Fifteen — Windows/OS Functions (continued)

ClipboardGetData Function

Overview

The ClipboardGetData function retrieves the specified clipboard format and copies it into a returned Data Object.

Syntax/Parameters

Syntax

handle = ClipboardGetData ( [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 handle to a Data Object or a NULL_HANDLE on failure. Use the GetLastError function to retrieve error information. The handle should be released with the CloseHandle function.

Remarks

Any format can be specified and the function will load a direct copy of the binary data into a Data Object and return a handle the resulting object. The object descriptor will be the clipboard format name.

A set of ‘get’ functions (see Related Functions below) can be used to access the content of binary data or retrieve string data.

Related Functions

ClipboardRegisterFormat — Registers or retrieves a clipboard format. 

ClipboardIsFormatAvailable — Tests for a specified format being available on the clipboard.

ClipboardSetData — Sets data to the clipboard from a variable, Pool Object or Data Object.

DataObjectWriteFile — Writes the contents of a Data Object to a file.

Get8Word — Gets an 8-bit byte from a string, char buffer or Data Object by offset with optional swap.

Get16Word — Gets a 16-bit word from string, char buffer or Data Object by offset with optional swap.

Get32Word — Gets a 32-bit dword from a string, char buffer or Data Object by offset with optional swap.

Get64Word — Gets a 64-bit qword from a string, char buffer or Data Object offset with optional swap.

Get32Float — Gets a 32-bit float from a string, char buffer or Data Object offset. Conversion is to 64-bit float.

Get64Float — Gets a 64-bit float from a string, char buffer or Data Object by offset.

Get8String — Gets an 8-bit string of characters from a string, char buffer or Data Object by offset.

Get16String — Gets a 16-bit wstring of characters from a string, char buffer or Data Object by offset.

[image links]

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 10/21/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.