Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5d

Application v 5.25a

  

 

Chapter SixFile Functions (continued)

MappedTextToString Function

Overview

The MappedTextToString function exports the contents of a Mapped Text or Edit Object to a string.

Syntax/Parameters

Syntax

string = MappedTextToString ( handle hObject, [boolean newline] );

Parameters

hObject

A handle to a Mapped Text or Edit Object.

newline

An optional boolean that if specified as non-zero will cause a new line character to be added to each line ending.

Return Value

Returns a string containing a copy of the contents of the Mapped Text Object or empty on failure. An empty object will result in an empty string. Use the GetLastError function to retrieve a formatted error code or IsError to check to see if an error occurred.

Remarks

Unless otherwise specified, line endings are marked with a single “/r” as opposed “/r/n”.

Related Functions

Platform Support

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

Legato IDE, Legato Basic