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

Table of Contents	< < Previous	Next >>

 

Chapter Eleven — SGML Functions (continued)

XBRLLoadTaxonomy Function

Overview

The XBRLLoadTaxonomy function loads the taxonomy referenced by an instance or as specified.

Syntax/Parameters

Syntax

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

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

Parameters

hXM

A handle to an XBRL Object. If this parameter is omitted, the function creates an XBRL Object and returns a handle to the object.

uri

A string to a taxonomy URI. When using an existing XBRL Object, this string can be omitted or empty which will force the loader to use the schema reference from the loaded instance. If loading with an instance, the URI can be unqualified in which case the base path of the instance source is used.

When creating a new XBRL Object, the a qualified URI is required.

hLog

A handle to an optional Log Object.

Return Value

If used with an XBRL Object handle, returns an int as ERROR_NONE on success or a formatted error code on failure.

If an XBRL Object is created, returns a handle to an XBRL Object or NULL_HANDLE 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.

When processing has been completed, the script should use the CloseHandle function to discard the handle, if created.

Remarks 

The XBRLLoadTaxonomy function can either load the taxonomy associated with an instance or load a standalone taxonomy.

With an Instance — When loading as part of an instance, an existing instance handle must be provided. The instance should contain a schema reference for the taxonomy that instance is employing. However, and if not, the uri can be provided which will override the schema reference.

Standalone — When loading a taxonomy without an instance, the instance functions such as retrieving facts, will return empty sets.

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.

Use the XBRLPostProcess function after the load and any imports to link all sections of the taxonomy. If the post process is not run, many high level taxonomy functions will return context errors.

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.

XBRLGetCalculationItem — Returns a calculation data item for a specified record.

XBRLGetConcepts — Returns all the properties associated with all concepts.

XBRLGetDefinitionLinks — Returns all the definition links.

XBRLGetInstanceFormat — Returns the source type of instance.

XBRLGetLabels — Returns all labels, their roles and properties.

XBRLGetReferences — Returns all references or only those items associated with a specified concept.

XBRLGetRoleList — Returns the list of roles defined within the taxonomy.

XBRLImportTaxonomy — Imports a taxonomy/schema.

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

XBRLPostProcess — Post process and join facts, concepts and other XBRL information.

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 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.