GoFiler Legato Script Reference   Legato v 1.5d Application v 5.25a

Table of Contents	< < Previous	Next >>

 

Chapter Six — File 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

CreateMappedTextFile — Creates a file and then opens it as a Mapped Text Object.

InsertLine — Inserts a line of text into a Mapped Text Object.

MappedTextSave — Saves a Mapped Text Object (remaps to new saved file).

OpenMappedTextFile — Opens the specified file as a Mapped Text Object.

ReadSegment — Reads a segment of data from a Mapped Text or Edit Object.

WriteSegment — Writes a segment of string data to a Mapped Text or Edit Object at an optional specified position.

Platform Support

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

Legato IDE, Legato Basic

 

Table of Contents	< < Previous	Next >>

GoFiler Legato Script Reference — Generated on 12/16/2024

© 2012-2024 Novaworks, LLC. All rights reserved worldwide. Unauthorized use, duplication or transmission prohibited by law. Portions of the software are protected by US Patents 10,095,672, 10,706,221 and 11,210,456. GoFiler™ and Legato™ are trademarks of Novaworks, LLC. EDGAR® is a federally registered trademark of the U.S. Securities and Exchange Commission. Novaworks is not affiliated with or approved by the U.S. Securities and Exchange Commission. All other trademarks are property of their respective owners. Use of the features specified in this language are subject to terms, conditions and limitations of the Software License Agreement.