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

Table of Contents	< < Previous	Next >>

 

Chapter Seventeen — Application Integration Functions (continued)

GetMappedTextObject Function

Overview

The GetMappedTextObject function returns the handle to a Mapped Text Object (MTO) associated with the specified window (view).

Syntax/Parameters

Syntax

handle = GetMappedTextObject ( handle hwTarget | int index | string name );

Parameters

hwTarget

If specified as a window handle, the request is sent directly to the window.

index

If an int is provided, it is expected to be an edit manager window index. The index can be -1 indicating that the active window is requested.

string

If a string is provided, an attempt is made to locate the window via the name of the window. Untitled windows cannot be accessed with this method.

Return Value

A handle to the created Mapped Text Object or NULL_HANDLE (0) for an error. If an error occurs, a structured error can be retrieved using the GetLastError function.

Remarks

As part of an edit window, all views share the same MTO. Every view, even if the underlying format is not text, will have an MTO even if it is just to manage the underlying file.

The MTO should be closed when all work has been completed. Do not hold an MTO open or get another object for the same window without first closing the previous handle.

See also Mapped Text Objects.

Related Functions

CloseHandle — Closes an object handle and releases any associated resources.

FindEditWindow — Returns an edit window index by locating a handle or filename.

FindEditWindowByAlias — Returns an edit window index by matching an alias name.

FindEditWindowView — Finds a view handle by name, index or handle.

GetEditObject — Gets an Edit Object and associates it with an edit window.

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

 

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.