Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5d

Application v 5.25a

  

 

Chapter FiveGeneral Functions (continued)

5.11 Object Meta Data

5.11.1 Overview

Certain objects allow for the storage of meta data. Meta data is not generally used or associated with the operation of the object, but rather, can be used by code that employs such objects. Meta data is for use by scripts or in some cases the application.

Meta data is stored as a string which is identified by a name, and optionally, by a section and title. The name can be any string so long as it is less than 512 characters and size. The data can also be anything so long as it does not contain a zero byte.

The section and title values can be used to group named items similar to sections in an application initialization (IN) file. They too are limited to 512 characters. Name, section and title make up a unique combination. All are case-sensitive.

Only certain object types support meta data:

Mapped Text Object — Attached directly and initialized when the first meta data element is added. Meta data is not saved or exported.

Edit Object – Attached as part of the associated Mapped Text Object.

Pool Object – String pools can also have meta data.

Since each edit window, even binary based windows such as Image View, must have an associated Mapped Text Object, object meta data can be attached and later referenced. This is useful if a script intercedes during an edit file open and wants to store information with the window for later reference. For example, perhaps when a file is opened, it is associated with a document management system, when the file is saved, a script hook might check the location and status. In order to do so, it would probably need to store information either as session data, or with the window. Object meta data can help with the task.

The string associated with a meta element can be up to 1,048,575 characters in length. All meta data is released when an object is closed.

5.11.2 Functions