GoFiler Legato Script Reference   Legato v 1.5b Application v 5.24b

Table of Contents	< < Previous	Next >>

 

Chapter Eleven — SGML Functions (continued)

XBRLImportTaxonomy Function

Overview

The XBRLImportTaxonomy function loads one or more schemas defining all or part of a taxonomy.

Syntax/Parameters

Syntax

int    = XBRLLoadTaxonomy ( handle hXM, string uri, [handle hLog] );

Parameters

hXM

A handle to an XBRL Object.

uri

A string to a taxonomy URI.

hLog

A handle to an optional Log Object.

Return Value

Returns an int as ERROR_NONE on success or a formatted error code on failure.

Note that coding errors do not count as a failure but the count is ORed in and returned as part of the return value and last error. Use the GetLastError function to retrieve error information.

Remarks 

The XBRLImportTaxonomy function can be used to import items that make of a taxonomy in its totality. This function is generally used as part of a process to create a taxonomy.

[needs import list]This function will track the imported URLs such that the imports can be added to an exported schema file or files.

If the function succeeds, the last error will contain a count of loading errors, such as a missing linkbase.

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.

If a progress window is open, the second status line is updated as linkbases are loaded.

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.

XBRLCreateObject — Creates an empty XBRL Instance Model.

XBRLGetConcepts — Returns all the properties associated with all concepts.

XBRLLoadInstance — Maps and loads the model and returns a handle to an XBRL Object.

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 10/21/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.