Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5b

Application v 5.24b

  

 

Chapter ElevenSGML Functions (continued)

HTMLSetTextMode Function

Overview

The HTMLSetTextMode function sets whether incoming text is encoded or not. By default, the incoming text is treated as text and converted to PCDATA. Using this function, the mode can be changed such that all incoming text is considered encoded and not altered when added to the HTML data set.

Syntax/Parameters

Syntax

int = HTMLSetTextMode ( handle hHWO, boolean mode, [boolean utf-8] );

Parameters

hHWO

A handle to an HTML Writer Object.

mode

A boolean value as TRUE (1) to indicate not to encode text (encoded by the caller) or FALSE (0) indicating to encode text.

utf-8

An optional boolean that indicates the incoming text strings are UTF-8 encoded.

Return Value

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

Remarks

When running in unencoded mode, the script can directly add HTML code in stream. For example, adding in <B> or <I> tags. A changed mode only applies to subsequent calls to add text.

Related Functions

Platform Support

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

Legato IDE, Legato Basic