GoFiler Legato Script Reference   Legato v 1.4j Application v 5.22b

Table of Contents	< < Previous	Next >>

 

Chapter Eleven — SGML Functions (continued)

XBRLLoadInstance Function

Overview

The XBRLLoadInstance function loads an instance from XBRL or iXBRL and returns a handle to an XBRL Object.

Syntax/Parameters

Syntax

handle = XBRLLoadInstance ( string filename, [dword mode], [handle hLog] );

handle = XBRLLoadInstance ( handle hObject, [handle hLog] );

Parameters

filename

A string to a qualified path and filename. Or,

hObject

A handle to an SGML, Edit or Mapped Text Object.

mode

An optional dword specifying file open options. These match the OpenMappedTextFile options. this parameter only applies to opening with a filename.

hLog

A handle to an optional Log Object.

Return Value

Returns a handle to an XBRL Object or NULL_HANDLE on failure. Use the GetLastError function to retrieve error information. When processing has been completed, the script should use the CloseHandle function to discard the handle.

Remarks 

The function will load the specified only from iXBRL or XBRL (XML). [JSON or CSV XBRL]. If does not load the taxonomy nor perform any post processing or indexing.

Instance data can be supplemented using the XBRLAddInstance function.

If a log handle is provided, any load errors will be logged in the object. Note, that function does not perform extensive testing of the incoming data but will report coding issues that impact the quality of the loaded instance.

Related Functions

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

GetDefaultLog — Returns the handle to the default log.

LogCreate — Creates a general log object with an optional log name and target filename base.

LogDisplay — Displays the specified log as a tab in the Information View window.

XBRLAddInstance — Supplements an existing instance with another.

XBRLCreateObject — Creates an empty XBRL Instance Model.

XBRLGetConcepts — Returns all the properties associated with all concepts.

XBRLGetInstanceFormat — Returns the source type of instance.

XBRLGetLabels — Returns all labels, their roles and properties.

XBRLLoadTaxonomy — Load and associated or specified taxonomy.

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 04/22/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.