GoFiler Legato Script Reference   Legato v 1.5b Application v 5.24b

Table of Contents	< < Previous	Next >>

 

Chapter Eleven — SGML Functions (continued)

SGMLWriteSegment Function

Overview

The SGMLWriteSegment function allows a segment of encoded data to be directly inserted or replace within the associated Mapped Text or Edit Object.

Syntax/Parameters

Syntax

int = SGMLWriteSegment ( handle hSGML, string data, int sx, int sy, int ex, int ey );

Parameters

hSGML

A handle to an SGML Object.

data

A string value to insert with PCDATA encoding.

sx  sy  ex  ey

A series of int values specifying the position to write the data. The X positions are specified as native values.

Return Value

An int as a formatted error code.

Remarks

SGMLWriteSegment allows direct access to write to the associated Mapped Text or Edit Object This alleviates the need to retrieve an object handle to perform a write segment.

The provided data must be encoded. Since the source segment is PCDATA, the source data can contain raw tags and character entities.

The parse position is not altered, nor is it compensated for. If the operation results in the X/Y position changing, it may no longer be valid after the starting position, the next parse will occur at an undefined location.

Avoid lines larger than 1,048,575 bytes in size.

Related Functions

IsPCDATARequired — Checks a string for a requirement to encode as PCDATA.

SGMLCreate — Creates an SGML Object and optionally attaches a specific object. Use CloseHandle to release.

SGMLWriteTag — Creates the tag and writes the data to the object managed by the destination handle.

WriteSegment — Writes a segment of string data to a Mapped Text or Edit Object at an optional specified position.

Platform Support

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

Legato IDE, Legato Basic

 

Table of Contents	< < Previous	Next >>

GoFiler Legato Script Reference — Generated on 10/21/2024

© 2012-2024 Novaworks, LLC. All rights reserved worldwide. Unauthorized use, duplication or transmission prohibited by law. Portions of the software are protected by US Patents 10,095,672, 10,706,221 and 11,210,456. GoFiler™ and Legato™ are trademarks of Novaworks, LLC. EDGAR® is a federally registered trademark of the U.S. Securities and Exchange Commission. Novaworks is not affiliated with or approved by the U.S. Securities and Exchange Commission. All other trademarks are property of their respective owners. Use of the features specified in this language are subject to terms, conditions and limitations of the Software License Agreement.