Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5d

Application v 5.25a

  

 

Chapter FifteenWindows/OS Functions (continued)

ClipboardGetFormats Function

Overview

The ClipboardGetFormats function returns an array of available formats currently contained on the clipboard.

Syntax/Parameters

Syntax

string[] = ClipboardGetFormats ( [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 array where each entry of the array contains a descriptive name of the clipboard format or an empty string on error. The array key names are set to the clipboard format code, such as ‘CF_TEXT’ or ‘cf_html’. Use the GetLastError function to retrieve a formatted error code.

Remarks

Clipboard formats are both defined by the operating system and by applications. See the list of types and codes defined in Section 15.5 Clipboard Functions.

Related Functions

Platform Support

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

Legato IDE, Legato Basic