Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5b

Application v 5.24b

  

 

Chapter FiveGeneral Functions (continued)

SetObjectMetaData Function

Overview

The SetObjectMetaData function sets a named meta string from a compatible object.

Syntax/Parameters

Syntax

int = GetObjectMetaData ( handle hObject, string name, string data );

int = GetObjectMetaData ( handle hObject, string section, string name, string data );

int = GetObjectMetaData ( handle hObject,
                      string title, string section, string name, string data );

Parameters

hObject

A handle to a compatible object.

name

A string containing the case-sensitive name of the meta data to retrieve.

section

An optional string containing a case-sensitive section name for grouping.

title

An optional string containing a case-sensitive title for grouping.

data

A string containing the meta data. The string can be up to 1,048,575 characters.

Return Value

Returns a string value or empty on failure. Use the GetLastError function to retrieve a formatted error code.

Remarks

If the object does not support meta data, the error code will be set to ERROR_FUNCTION_NOT_SUPPORTED.

Related Functions

Platform Support

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

Legato IDE, Legato Basic