Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.4j

Application v 5.22b

  

 

Chapter ElevenSGML Functions (continued)

OutlineSetObject Function

Overview

The OutlineSetObject function sets a specified object into the Outline Object and outlines the data.

Syntax/Parameters

Syntax

int = OutlineSetObject ( handle hOutline, handle hSource, [dword flags],
                    [int s_x, int s_y, [int e_x, int e_y]] );

Parameters

hOutline

A handle to an HTML Outline Object.

hSource

A handle specifying an object to map the content. The parameter can be a Mapped Text, Edit, or an SGML Object.

flags

An optional dword value specifying mapping flags. See Basic Operation at the beginning of this section for flags. The default is flags to zero or none. If a range is specified, the flags parameter must be provided.

s_x    s_y

An optional pair of zero-based int values specifying the starting position to perform the scan.

e_x    e_y

An optional pair of zero-based int values specifying the ending position to stop the scan.

Return Value

An int specified a ERROR_NONE or a formatted error code.

Remarks

Depending on the size of the incoming data, the function can take some time to map and return.

The embedded mapped text object is borrowed to perform the outline map. As such, if an SGML Object is supplied, operations within the Outline Object do not alter information within the SGML object. If the source object’s file content are altered, those alterations do not update the outline information. In such a case it is best to discard the Outline Object and create a new outline.

Do not release the source object prior to closing the HTML Outline Object.

Related Functions

Platform Support

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

Legato IDE, Legato Basic