Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5d

Application v 5.25a

  

 

Chapter ElevenSGML Functions (continued)

HTMLWriterToFile Function

Overview

The HTMLWriterToFile function writes the current content of the object to a specified file.

Syntax/Parameters

Syntax

int = HTMLWriterToFile ( handle hObject, string name );

Parameters

hObject

A handle to an HTML Writer Object.

name

A string specifying a qualified path and filename as the destination for the data.

Return Value

An int containing a formatted error code, ERROR_NONE (0) for no error. Note that this function can return errors with respect to creating and writing the destination file.

Remarks

Any open tables, paragraphs or other information is wrapped up prior to rendering the buffer. If an HTML header was added, the footer will be added. This means that code can no longer be added to the object.

By default, line endings are set to a single CR (0x0D). Use the HTMLSetNewLineMode function to change the line ending mode.

Related Functions

Platform Support

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

Legato IDE, Legato Basic