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

Table of Contents	< < Previous	Next >>

 

Chapter Eleven — SGML Functions (continued)

SGMLNextItem Function

Overview

The SGMLNextItem function parses the incoming data and returns a tag, space, a character entity or a PCDATA word from the next parse position or a specified location.

Syntax/Parameters

Syntax

string = SGMLNextItem ( handle hSGML, [int x, int y] );

Parameters

hSGML

A handle to an SGML object.

x

An optional int value specifying the zero-based X position to parse from. The position is native. When provided, the Y position must also be provided. If omitted, the function parses from the current position.

y

An optional int value specifying the zero-based Y position to parse from. The X position must be provided with this parameter.

Return Value

A string containing the tag’s text, an empty string on error. Use the GetLastError function to retrieve an error code.

Remarks

The total size of a tag’s data is limited to 4,096 bytes and the total size of an item cannot exceed 1,048,575 bytes. In the event of an overflow, an error condition will be set and the coordinates set for the complete item so it can be manually parsed or loaded.

Each item parsed sets the statistics for the item such as the type and its end points. For elements, the element attributes/properties are parsed and loaded into the SGML Object.

Related Functions

SGMLGetElementToken — Returns the current element as a token value.

SGMLGetItemPosEX — Gets the position for the ending X last parsed item.

SGMLGetItemPosEY — Gets the position for the ending Y last parsed item.

SGMLGetItemPosSX — Gets the position for the starting X last parsed item.

SGMLGetItemPosSY — Gets the position for the starting Y last parsed item.

SGMLGetItemResult — Gets the parse result flags.

SGMLGetItemType — Gets the last parsed item type.

SGMLGetParameter — Gets a specified parameter (attribute/CSS) as a string.

SGMLNextElement — Gets the next element (skips spaces, text, entities) at the current or specified parse position.

SGMLPreviousElement — Gets the previous element (skips spaces, text, entities) at the current or specified parse position.

SGMLSetDataRange — Sets (restricts) the data range. Default end position is end of file (object).

SGMLSetPosition — Sets the parse position in terms of X/Y.

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.