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

Table of Contents	< < Previous	Next >>

 

Chapter Eleven — SGML Functions (continued)

SGMLFindElement Function

Overview

The SGMLFindElement function parses forward until the specific element is found.

Syntax/Parameters

Syntax

string = SGMLFindElement ( handle hSGML, TOKEN token | string element, [int x, int y] );

Parameters

hSGML

A handle to an SGML object.

token

An optional TOKEN (dword) for an HTML token or other element as defined in the DTD. Or,

element

A string version of the HTML or other element. One of the token or element must be provided.

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 SGMLFindElement skips all tags, spaces, character entities and PCDATA to get to the specified element. If the end of data is reached prior to a tag, an empty string is returned and ERROR_EOD will be placed in the last error buffer.

The current position, properties and other characteristic are made available through various ‘get’ functions.

Since SGMLFindElement only reads tags, the tag will be parsed into its components.

Related Functions

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.

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.

SGMLNextItem — Gets the next item at the current or specified parse position.

SGMLPreviousElement — Gets the previous element (skips spaces, text, entities) at the current or specified parse 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.