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

Table of Contents	< < Previous	Next >>

 

Chapter Fifteen — Windows/OS Functions (continued)

ClipboardGetFormatCode Function

Overview

The ClipboardGetFormatCode function retrieves the registered or general name associated with a clipboard format.

Syntax/Parameters

Syntax

dword = ClipboardGetFormatCode ( [handle hClipboard], string name );

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.

name

A string as a clipboard format name. See the list of types and codes defined in Section 15.5 Clipboard Functions.

Return Value

Returns a dword that contains format code or zero on failure. Use the GetLastError function to retrieve the application code or a formatted error code.

Remarks

Clipboard format names and codes are either predefined or registered. For predefined formats, such as simple text, operating system will not store a related name since the format is well-known. For user-defined formats, the registered name identifies the format. For ease of use within Legato, the formats always have a name with the distinction that predefined formats cannot be referenced by name from other applications.

Related Functions

ClipboardGetData — Gets raw data from the clipboard for a specified format as a Data Object.

ClipboardGetFormatName — Gets the name of a registered or predefined clipboard format.

ClipboardGetFormats — Returns a list of available formats from the clipboard.

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

ClipboardOpen — Opens the clipboard and returns a handle.

ClipboardRegisterFormat — Registers or retrieves a clipboard format.

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

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.