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

Table of Contents	< < Previous	Next >>

 

Chapter Eleven — SGML Functions (continued)

FieldGetFieldResult Function

Overview

The FieldGetFieldResult function returns the parse result code.

Syntax/Parameters

Syntax

dword = FieldGetFieldResult ( handle hField );

Parameters

hField

A handle to a Field Object.

Return Value

A dword containing bitwise values specifying the details of the last parse results or 0x00000000 on failure. Use the GetLastError function to retrieve a formatted error code.

Remarks

The bitwise result 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

 

The return value will normally contain the FIELD_RESULT_DATA bit set after a successful parse operation.

The Field Object must have a data object associated to use this function.

Related Functions

FieldCreateObject — Creates a Field Object from an SGML, Mapped Text or Edit Object.

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.

FieldGetFieldProperties — Returns all properties associated with a field.

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.