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

Table of Contents	< < Previous	Next >>

 

Chapter Eleven — SGML Functions (continued)

FieldGetFieldContent Function

Overview

The FieldGetFieldContent function parses forward to locate the corresponding closing field to the current field in the Field Object and collects all the content data into a string.

Syntax/Parameters

Syntax

string = FieldGetFieldContent ( handle hField );

Parameters

hField

A handle to a Field Object.

Return Value

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

Remarks

The maximum size that can be retrieved is 2MB. A field must be loaded into the Field Object. If the field is not defined to have content, the function will return an error. The companion function FieldFindClosingField will locate the closing field and return the token of the close field.

Not all fields will have content. For example, the Set field does not have content. If the loaded field is not a container type, an error will be returned.

Upon returning a string, the current start and end file positions for the returned content are set for the Field Object. Use the get position functions to retrieve the location.

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.

FieldFindField — Finds a specific field by token or name from the current or specified parse point.

FieldFindClosingField — Locates the closing field based on the current field.

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.

FieldNextField — Scans forward from the current or specified position to locate a field.

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.