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

Table of Contents	< < Previous	Next >>

 

Chapter Eleven — SGML Functions (continued)

SGMLFindClosingElement Function

Overview

The SGMLFindClosingElement function looks for a matching closing element based on the current element and gathers HTML or text during the search.

Syntax/Parameters

Syntax

string = SGMLFindClosingElement ( handle hSGML, dword flags );

Parameters

hSGML

A handle to an SGML object.

flags

An optional dword specifying operational flags. If omitted, the default is SP_FCE_TRANSLATED_TEXT.

Return Value

A string containing the HTML or ANSI code between the current tag and the tag found. The string will be empty on error. Use the GetLastError or IsError function to check whether an error occurred or valid empty tag set was returned.

Remarks

The current item must be an open tag. The content of the returned string is determined by the flags parameter:

	Defined		Bitwise		Description
	SP_FCE_NONE		0x00000000		No Flags
	SP_FCE_TRANSLATE_CHARS		0x00000001		Translate Characters to ANSI
	SP_FCE_TEXT_ONLY		0x00000002		Get Just the Text from Content
	SP_FCE_TRANSLATED_TEXT		0x00000003		Combination
	SP_FCE_CODE_AS_IS		0x00000010		Return Code As Is (not white spaced)
	SP_FCE_INCLUDE_WRAPPER		0x00000020		Adds Open and Close Tags

 

The returned string cannot be larger than 2MB.

Related Functions

SGMLCreate — Creates an SGML Object and optionally attaches a specific object.

SGMLFindElement — Finds a specific element with optional starting position.

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.

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.