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

Table of Contents	< < Previous	Next >>

 

Chapter Eleven — SGML Functions (continued)

XBRLSetOptions Function

Overview

The XBRLSetOptions function allows various options to be set for the XBRL Model.

Syntax/Parameters

Syntax

int = XBRLSetOptions ( handle hXM, dword options );

Parameters

hXM

A handle to an XBRL Object.

options

A dword specifying the options to set.

Return Value

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

Remarks

The following options can be set:

	SDK Definition			Bitwise		Descritption
	API Options
		XM_OPTIONS_TERSE_DATA_SETS		0x00000001		Do Not Report Certain Items
		XM_OPTIONS_VERBOSE_DATA_SETS		0x00000002		Report Extra Items Certain Items
	Model Processing
		XM_OPTIONS_NO_TAXONOMY_ERRORS		0x00010000		Do Not Report Taxonomy Errors

 

The XM_OPTIONS_NO_TAXONOMY_ERRORS option suppresses certain taxonomy errors from being added to the log. this is helpful if the taxonomies in use may have errors that the user cannot control but other errors need to be reported. An instance can be loaded with XBRLLoadInstance, this option set and then the XBRLLoadTaxonomy and XBRLPostProcess functions can be run.

The terse and verbose options apply in particular to retrieving fact data sets both that are very large or desire all the associated data to be reported in a single call.

Related Functions

XBRLGetContexts — Returns the data for select XBRL contexts as directed by one or more filters.

XBRLGetFacts — Returns a list of facts for the specified context.

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

XBRLLoadTaxonomy — Load and associated or specified taxonomy.

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