Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.4j

Application v 5.22b

  

 

Chapter Twenty-oneEDGARView Integration (continued)

EDACOpenFile Function

Overview

The EDACOpenFile function opens a project or XML compose file, selects an object and loads the data.

Syntax/Parameters

Syntax

handle = EDACOpenFile ( string filename );

Parameters

filename

A string containing a filename to open.

Return Value

Returns a handle to an EDAC Object or NULL_HANDLE on error. Use the GetLastError function to retrieve a formatted error code. The GetLastErrorMessage can also contain additional details.

Use the CloseHandle function to discard the object.

Remarks

The file type is determined prior to opening the file to direct which module should process the request. The open function operates independently from any open EDGAR View, but if the file is the active project, the handle will point to the currently open project file.

GFP, XML and EIS files can be opened. Note that opening an XML or EIS can result in document files being extracted to the folder that the source file is located in.

Closing the handle discards all information associated with the EDAC object. To save changes, use the EDACSaveFile function.

Opening a file that is already open within the desktop will cause the internal database to be synchronized with the form editor. When the handle is closed, the data base is set back to the desktop form editor. Programmers should avoid constantly opening and closing EDAC objects since this will result in significant delays and screen chatter.

Further, avoid opening a view as a background thread. Thread locking has not been tested.

Related Functions

Platform Support

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