Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.6b

Application v 6.0c

  

 

Chapter FiveGeneral Functions (continued)

DataObjectCreate Function

Overview

The DataObjectCreate function creates an empty Data Object.

Syntax/Parameters

Syntax

handle = DataObjectCreate ( string descriptor, [int size] );

Parameters

descriptor

A string containing an object descriptor of up to 15 characters.

size

An optional int specifying the initial allocated size of the object.

Return Value

Returns a handle value for a Data Object or NULL_HANDLE on failure. Use the GetLastError function to retrieve a formatted error code.

Remarks

The size requirement will be the minimum size of the object. Allocation is performed in granules of 4K or 8K. If omitted, the Data Object is not initially allocated.

The Data Object Descriptor is a 15 character string that defines the content of the data object. For example, a descriptor from a GIF image retrieved from the clipboard is “GIFDataObject”.

Descriptors help both Legato SDK functions and programmers determine the content of a Data Object.

Use caution changing descriptor names since certain SDK functions may expect a certain name to perform their respective functions.

Related Functions

Platform Support

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

Legato IDE, Legato Basic

Page revised 2025-04-28