Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.4j

Application v 5.22b

  

 

Chapter ElevenSGML Functions (continued)

SGMLSetElement Function

Overview

The SGMLSetElement function allows the element token for the element class to be changed. This does not alter the remaining data in the element class.

Syntax/Parameters

Syntax

int = SGMLSetElement ( handle hSGML, TOKEN token | string element );

Parameters

hSGML

A handle to an SGML Object.

token

An optional TOKEN (dword) for an HTML token or other element as defined in the DTD. Or,

element

A string version of the HTML or other element. If the token or element is omitted, the SGML Object element class is initialized with no element value.

Return Value

An int as ERROR_NONE (0) or a formatted error code.

Remarks

The SGMLSetElement does not alter any other properties of the SGML Object.

For standard W3C defined elements, SDK defined token values can be referenced with the following standard prefixes:

HT_ — HTML token, for example HT_TABLE or HT_P for “<TABLE>” and “<P>”

Note that any where a dash ‘-’ is used in a name, it is replaced with an underbar ‘_’. See Appendix A — Legato SDK Standard Definitions. for a complete list of definitions.

If the element is specified and does not exist, an error will be returned. If the token is used, it is not tested against the DTD and if incorrect will result in an error when rendering the tag contents.

Related Functions

Platform Support

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

Legato IDE, Legato Basic