Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5d

Application v 5.25a

  

 

Chapter ElevenSGML Functions (continued)

HTMLWriterToString Function

Overview

The HTMLWriterToString function clears all pending actions and copies the current content of the object to a string.

Syntax/Parameters

Syntax

string = HTMLWriterToString ( handle hObject );

Parameters

hObject

A handle to an HTML Writer Object.

Return Value

A string containing the contents of the HTML Writer Object. If an error occurs, the string will be empty. Use the GetLastError function to return a formatted error code.

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.

The result cannot exceed 2MB.

The line endings are set to a single CR (0x0D) by default, 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