Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5b

Application v 5.24b

  

 

Chapter ElevenSGML Functions (continued)

FieldWrite Function

Overview

The FieldWrite function writes the field back to the associated object.

Syntax/Parameters

Syntax

int = FieldWrite ( handle hField, [int x, int y] );

Parameters

hField

A handle to a Field Object.

x  y

An optional pair of int values specifying an insert position. If omitted, the position of the current field content is used.

Return Value

A int as ERROR_NONE or a formatted error code on failure. Use GetLastError and GetLastErrorMessage to retrieve additional error information.

Remarks

The FieldWrite function writes the current field in the object to the associated Edit or Mapped Text Object. If the Field Object is empty, an error will be returned.

The position may be specified as an insert position or if not specified, the last segment position will be used to overwrite the previously parsed field as read by FieldFindField or FieldNextField.

Related Functions

Platform Support

Go13, Go16, GoFiler Complete, GoFiler Corporate, GoFiler, GoFiler Lite, GoXBRL

Legato IDE, Legato Basic