Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.4j

Application v 5.22b

  

 

Chapter FiveGeneral Functions (continued)

DataObjectSetDescriptor Function

Overview

The DataObjectSetDescriptor function sets the descriptor string for a Data Object.

Syntax/Parameters

Syntax

int = DataObjectSetDescriptor ( handle hData, string descriptor );

Parameters

hData

A handle specifying the Data Object.

descriptor

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

Return Value

Returns an int as ERROR_NONE or a formatted error code on failure.

Remarks

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