Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5b

Application v 5.24b

  

 

Chapter ElevenSGML Functions (continued)

FieldFindField Function

Overview

The FieldFindField function parses forward to locate the specific HTML field structure.

Syntax/Parameters

Syntax

dword = FieldFindField ( handle hField, string name | dword token, [int x, int y] );

Parameters

hField

A handle to a Field Object.

name

A string containing a field type name to find. If the name cannot be translated to a known token, a ERROR_RANGE error will be returned. Or,

token

A dword containing a field name token value to find.

x

An optional int value specifying the zero-based X position to parse from. The position is native. When provided, the Y position must also be provided. If omitted, the function parses from the current position.

y

An optional int value specifying the zero-based Y position to parse from. The X position must be provided with this parameter.

Return Value

A dword containing a field token or a formatted error code on failure.

Remarks

If the x and y parameters are not provided, the scan starts from the end of the last field found. The default starting position for the first parse 0, 0. The current parse position is shared by all field functions that load or look for fields.

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

Related Functions

Platform Support

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

Legato IDE, Legato Basic