Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.4j

Application v 5.22b

  

 

Chapter ElevenSGML Functions (continued)

SGMLGetElementString Function

Overview

The SGMLGetElementString function reads the token value from the last parsed item and returns the string version element name. If the element does not have a token, the raw string is returned.

Syntax/Parameters

Syntax

string = SGMLGetElementString ( handle hSGML );

Parameters

hSGML

A handle to an SGML Object.

Return Value

A string as the element name or an empty string on error. Use the GetLastError function to retrieve a formatted error code.

Remarks

The last item in the parse buffer must be a SPI_TYPE_TAG or an error will be returned.

If the element could not be located in the DTD, the token will be set to PT_STRING and point to the SGML heap. In that case, the string is retrieved from the heap and returned. To indicate that the element was in error, the last error will be set to ERROR_CONTEXT.

Note that the token can be changed by the SGMLResetElement function.

Related Functions

Platform Support

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

Legato IDE, Legato Basic