Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.6d

Application v 6.1b

  

 

Chapter FiveGeneral Functions (continued)

XMLParseGetPosition Function

Overview

The XMLParseGetPosition function returns the start and end X/Y positions of the last parsed item.

Syntax/Parameters

Syntax

int[] = XMLParseGetPosition ( handle hXPO );

Parameters

hXPO

handle specifying an XML Parse Object.

Return Value

Returns a int array of zero-based or an empty array on failure. Use the GetLastError function to retrieve error information. The GetLastErrorMessage can contain information on ERROR_CONTEXT.

Remarks

Each parse action by the XMLParseGetItem function will load information about the item including its position. For file-based source objects, the positions are represented as X/Y (character, line) values while for string source positions are represented as X positions only. As such, the Y position will always be zero even if the file contains line endings.

The returned key name and array positions are as follows:

s_x   0    Start X position

s_y   1    Start Y position

e_x   2    End X position

e_y   3    End Y position

 

Related Functions

Platform Support

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

Legato IDE, Legato Basic

Page revised 2025-08-15