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

Table of Contents	< < Previous	Next >>

 

Chapter Fifteen — Windows/OS Functions (continued)

ClipboardRegisterFormat Function

Overview

The ClipboardRegisterFormat looks for a existing clipboard format name and returns it clipboard format code. If it does not exist, registers the format and returns a code.

Syntax/Parameters

Syntax

dword = ClipboardRegisterFormat ( string name );

Parameters

name

A string containing the name of the format.

Return Value

Returns a dword value as a clipboard format code or 0x00000000 on error. Use the GetLastError function to retrieve a formatted error code.

Registered clipboard formats are identified by values in the range 0xC000 through 0xFFFF.

Remarks

If a registered format with the specified name already exists, a new format is not registered and the return value identifies the existing format. This enables more than one application to copy and paste data using the same registered clipboard format.

Format names provide a method for applications to share common formats over the clipboard. The returned format code can be used to directly get or post information to the clipboard.

Formats are built into the Window API (therefore should not be registered) as specified at the start if this section. In addition, the application will automatically register the following formats:

	Format Name			Description
	Application Proprietary
		NWS Control		Novaworks Application Control
		NWS Data		Novaworks Application Data
		NWS Delay Control		Novaworks Delay Control
		NWS Exchange		Novaworks Data Exchange
		NWS Objects		Novaworks Application Objects
	De facto Standards
		CSV		Comma Delimited Format
		DataObject		Data Object
		HTML Format		HTML (Windows) Format
		HTML Native		HTML Native Format
		GIF		GIF Image Format
		HyperLink		HyperLink
		JFIF		JPEG Image Format
		Link Source		Link Source
		Link Source Descriptor		Link Source Descriptor
		msSourceUrl		MS Source URL (msSourceUrl)
		Object Descriptor		Object Descriptor
		ObjectLink		Object Link Data (ObjectLink)
		OwnerLink		Owner Link Data
		Ole Private Data		OLE Private Data
		PNG		PNG Image Format
		Rich Text Format		Rich Text Format
	Specific Microsoft
		MSDEVColumnSelect		Visual Studio Column Select (VS)
		Embed Source		Embed Source
		Native		Native (Microsoft Word)

 

There are also built-in Windows SDK formats for text, Unicode, DIB, etc... Programmers are cautioned in create names that may conflict with other applications unless those names are used to transport appropriately formatted data.

Format name comparison is case-insensitive.

Related Functions

ClipboardCreate — Empties the clipboard and returns a clipboard handle.

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

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

ClipboardOpen — Opens the clipboard and returns a handle.

ClipboardSetText — Sets text to the clipboard.

ClipboardSetUnicode — Sets Unicode text to the clipboard.

PoolCreate — Creates a String Pool Object (SPO) and optionally loads the pool with a string.

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.