Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.6d

Application v 6.1b

  

 

Chapter FiveGeneral Functions (continued)

XMLParseCreate Function

Overview

The XMLParseCreate function creates an XML Parse Object and loads the specified data.

Syntax/Parameters

Syntax

handle = XMLParseCreate ( handle hSource | string data );

Parameters

hSource

A handle specifying a Mapped Text Object, Edit Object or Basic File Object. Or,

data

A string containing the data to parse or specifies a fully qualified source URL. Characters ‘<‘ and return (0x0D and 0x0A) are used to determine whether the string is a file or XML data.

Return Value

Returns a handle to a XML Parse Object or a NULL_HANDLE on failure. Use the GetLastError function to retrieve error information.

Remarks

The XMLParseCreate function initializes the object and loads the data as required. It does not scan the data.

To start parsing, use the XMLParseGetItem function until it does not return data which presumably means all the data has been exhausted (or some other error occurred).

During the parsing process, the last error should be checked to determine if there was a parsing error from a malformed tag. The returned string will be a portion of the erroneous tag.

Related Functions

Platform Support

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

Legato IDE, Legato Basic

Page revised 2025-08-15