Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5b

Application v 5.24b

  

 

Chapter ElevenSGML Functions (continued)

HTMLSetEncoding Function

Overview

The HTMLSetEncoding function sets the encoding for the writer and if a header is added, sets the DTD for the resulting document.

Syntax/Parameters

Syntax

int = HTMLSetEncoding ( handle hObject, int type );

Parameters

hObject

A handle to an HTML Writer Object.

type

A dword (or int) specifying the encoding. See the remarks for codes. If omitted, the default encoding is 8-bit with ISO-8859-1.

Return Value

Returns an int as ERROR_NONE or a formatted error code on failure. Use the GetLastError function to retrieve error information.

Remarks

If an encoding is not added, browsers generally process documents as ISO-8859 with the full CP-1252 (Code Page 1252, or Windows-1212 also known as ANSI). Of course, all character positions can be represented with character entities without regard to the encoding.

  Definition   Bitwise   Description
  HC_ENCODE_DEFAULT   0x00000000   Default (CP1252/ISO Latin ANSI)
  HC_ENCODE_ISO_8859   0x00000001   ISO-8859 (8-bit).
  HC_ENCODE_XML   0x00000002   UNICODE XML (do not use character entity names except the standard for & < and >).
  HC_ENCODE_UTF   0x00000010   Universal Coded Character Set Transformation Format for 8 bits. The underlying character set is UNICODE.

 

When using the XML flag, the character encoding, and by default the character set, is set to UTF-8 and UNICODE.

Related Functions

Platform Support

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

Legato IDE, Legato Basic