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

Table of Contents	< < Previous	Next >>

 

Chapter Eleven — SGML Functions (continued)

EnumerateSetFields Function

Overview

The EnumerateSetFields function returns table of all SET fields within the specified document.

Syntax/Parameters

Syntax

string[][] = EnumerateSetFields ( handle hObject | string name );

Parameters

hObject

A handle to a Mapped Text, Edit or SGML Object. Or,

name

A string specifying a source filename to scan for set fields.

Return Value

A string table containing set field parameters or an empty array on failure. Use the GetLastError function to retrieve a formatted error code.

Remarks

Set fields are enumerated as a series of rows, one for each field, with the following column key names.

	Key Name		Description
	s_x		File position in zero-based decimal.
	s_y		File position in zero-based decimal.
	e_x		File position in zero-based decimal.
	e_y		File position in zero-based decimal.
	name		Set value name. Either this field or the id should uniquely identify the set group.
	id		Set value id. Either this field or the name should uniquely identify the set group.
	value		Optional value for the field.
	file		Optional filename for the field (for script).
	function		Optional function name for the field (for script).

 

 

Related Functions

FieldFromParameters — Creates a field string based on supplied parameters.

FieldGetParameter — Gets the value for a specified parameter as a string or token.

FieldGetParameters — Returns an array of all parameters as key names and values.

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

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

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

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

FieldGetFieldResult — Gets the parse result flags.

FieldGetFieldToken — Returns the field token value.

FieldGetParseString — Returns a copy of the parse buffer from the last parse action.

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.