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

Table of Contents	< < Previous	Next >>

 

Chapter Seventeen — Application Integration Functions (continued)

EnumerateEditFiles Function

Overview

The EnumerateEditFiles function returns a list of edit window filenames and handles.

Syntax/Parameters

Syntax

string [] = EnumerateEditFiles ( [boolean modified] );

Parameters

modified

An optional boolean when set to TRUE causes only edit windows with the modified flag set to be enumerated. The default value is FALSE, enumerating all windows.

Return Value

Returns a string array of filenames and paths or an empty array on failure. Use the GetLastError and IsError functions to retrieve error information or test for an error. The key names for the array will contain a string version of the window handle.

Remarks

An untitled window will be returned as an empty string within the array. The key name will contain a string version of the window handle for the MDI client window for the edit object. Use the MakeHandle function to convert the key name to an actual window handle and the FindEditWindowView function to get the handle to any view contained within the client.

Related Functions

EnumerateEditWindows — Enumerates a table of all edit windows and their properties.

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.

GetActiveEditWindow — Returns the handle to the active edit window.

MakeHandle — Converts an integer or formatted string to a handle value. The string can be hex, octal or decimal.

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.