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

Table of Contents	< < Previous	Next >>

 

Chapter Eleven — SGML Functions (continued)

FieldCreateObject Function

Overview

The FieldCreateObject function creates a Field Object based on an SGML, Mapped Text or Edit Object. The Field Object can then be used to access and modify field data within the attached object. An unassociated Field Object can also be created.

Syntax/Parameters

Syntax

handle = FieldCreateObject ( [handle hObject] );

Parameters

hObject

An optional handle to an SGML, Mapped Text or Edit Object.

Return Value

A handle to a Field Object or NULL_HANDLE on failure. Use the GetLastError function to retrieve a reformatted error code. Use the CloseHandle function to close the object.

Remarks

If a source handle is not specified, the parsing functions will not operate. With a specified source handle, the default starting parse position is set to 0, 0.

If an SGML Object is used, its parse mode will automatically be placed in ‘comment colon multiple’ which allows CSS style property-value pairing. The mode is not restored to simple comments upon completion.

Related Functions

CloseHandle — Closes an object handle and releases any associated resources.

CreateMappedTextFile — Creates a file and then opens it as a Mapped Text Object.

CreateMappedTextString — Creates a Mapped Text Object based on a string.

FieldLoadString — Loads a string into a new Field Object.

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

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

GetEditObject — Gets an Edit Object and associates it with an edit window.

GetMappedTextObject — Gets the associated Mapped Text Object for an edit window.

SGMLCreate — Creates an SGML Object and optionally attaches a specific object. Use CloseHandle to release.

OpenMappedTextFile — Opens the specified file as a Mapped Text 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.