Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5b

Application v 5.24b

  

 

Chapter FiveGeneral Functions (continued)

DataObjectLoadFile Function

Overview

The DataObjectLoadFile function creates a Data Object from data loaded from a file.

Syntax/Parameters

Syntax

handle = DataObjectLoadFile ( string name, [string descriptor] );

Parameters

name

A string containing a fully qualified filename to load. It can be local or a URL.

descriptor

An optional string containing an object descriptor of up to 15 characters. If omitted, the descriptor is determined by the file extension. If the descriptor cannot be determined or is not supported, a range error will be returned.

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 DataObjectLoadFile function allows a binary image of any file to be loaded into a Data Object. Depending on the content, various other functions can access or modify the content of the object.

Related Functions

Platform Support

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

Legato IDE, Legato Basic