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

Table of Contents	< < Previous	Next >>

 

Chapter Eleven — SGML Functions (continued)

FieldToParameters Function

Overview

The FieldToParameters function reads a field string on-the-fly without a Field Object and creates a list of parameters.

Syntax/Parameters

Syntax

string[] = FieldToParameters ( string data );

Parameters

data

A string containing the field tag data.

Return Value

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

If the field type is not a well known type, the field value is set as the first property. The last error will contain the result bits with the flag FIELD_RESULT_UNKNOWN_FIELD_NAME set.

Remarks

The first entry will be ‘Field’ with a field type name. Each following key name will be the property-value pair for each parameter.

The field entry will always be the field name whether known or unknown. Check the last error to determine there was an error. The codes are as follows:

	Definition			Bitwise		Description
	Errors
		FIELD_RESULT_ERROR_MASK		0x0000FFFF		Result Error Mask
		FIELD_RESULT_UNKNOWN_PROPERTY		0x00000001		Unknown Properties Name
		FIELD_RESULT_PARAMETER_ERROR		0x00000002		Error in Parameter
		FIELD_RESULT_UNKNOWN_FIELD_NAME		0x00000004		Unknown Field Name
	Conditions
		FIELD_RESULT_SELF_CLOSE		0x00010000		Field Is Self-Close
		FIELD_RESULT_STOPPED		0x00020000		Stopped on HTML/XML Tag
		FIELD_RESULT_DATA		0x10000000		Currently Contains Data

 

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.

FieldToString — Creates a string version of the current field object.

FieldWrite — Writes the current field back to the source object.

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.