Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5b

Application v 5.24b

  

 

Chapter FifteenWindows/OS Functions (continued)

ClipboardSetPNG Function

Overview

The ClipboardSetPNG sets data as PNG format onto the Windows clipboard via a Clipboard Object.

Syntax/Parameters

Syntax

int = ClipboardSetPNG ( handle hClipboard, var data | handle hObject );

Parameters

hClipboard

A handle to a Clipboard Object.

data

A variable of a type that is 1 byte wide such as char or byte. See Remarks below, or,

hObject

A handle to a Data Object containing the data to place on the clipboard. The data descriptor for the data object is not tested.

Return Value

Returns an int value as ERROR_NONE or a formatted error code.

Remarks

The ClipboardSetPNG function places data on the clipboard using the PNG format designator. The source information can be held in a Data Object or byte array.

The function does not check the validity of the data. It also does not alter the content. It is up to the caller to verify that the source data is of the correct format.

The Clipboard Object must first be created using the ClipboardCreate function. Multiple formats can be posted to the clipboard.

Related Functions

Platform Support

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

Legato IDE, Legato Basic