Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.4j

Application v 5.22b

  

 

Chapter SixFile Functions (continued)

CreateMappedTextString Function

Overview

The CreateMappedTextString function creates a Mapped Text Object from a string.

Syntax/Parameters

Syntax

handle = CreateMappedTextString ( string data );

Parameters

data

A string to be copied and mapped. The string can use carriage returns and/or newlines characters for line endings.

Return Value

Returns a handle for a Mapped Text Object or NULL_HANDLE on failure. Use the GetLastError function to retrieve error information.

Remarks

Mapped Text Objects provide enhanced editing capabilities over basic strings. In addition to offering better control of positioning within the text, Mapped Text Objects allow for more complicated editing functionality such as transactions. Once the CreateMappedTextString function is called, the Mapped Text Object can be edited by adding, altering, or deleting text. The original string is not altered.

Related Functions

Platform Support

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

Legato IDE, Legato Basic