Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.4j

Application v 5.22b

  

 

Chapter FifteenWindows/OS Functions (continued)

ClipboardGetFormatName Function

Overview

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

Syntax/Parameters

Syntax

string = ClipboardGetFormatName ( [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

Clipboard format names 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

Platform Support

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

Legato IDE, Legato Basic