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

Table of Contents	< < Previous	Next >>

 

Chapter Eleven — SGML Functions (continued)

XBRLValidateByDataType Function

Overview

The XBRLValidateByDataType function allows a string to be validated by a specified XBRL Data Type.

Syntax/Parameters

Syntax

int = XBRLValidateByDataType ( [handle hXM], string type, string data );

Parameters

hXM

An optional handle to an XBRL Object.

type

A string specifying the Data Type name to validate against.

data

A string containing the data to validate.

Return Value

Returns an int as ERROR_NONE on a successful validation or an error code on failure. Use the GetLastError function to retrieve the same formatted error code and GetLastErrorMessage to retrieve narrative on the error.

Remarks

If an XBRL Model Object is not provided, the model is reinitialized and the Data Type table reloaded on every call. This can be very inefficient and should be avoided when validating a large number of data items. To avoid this, a call to XBRLCreateObject can be run and the handle used on each call.

When using the default model, only XML and XBRL defined data types will be available. To import other data types (schemas), a taxonomy must be loaded or data type schemas imported.

Related Functions

XBRLCreateObject — Creates an empty XBRL Instance Model.

XBRLGetConcept — Returns all the properties associated for a specified concept.

XBRLGetDataType — Return a data type by position or name.

XBRLGetDataTypeCount — Returns the number of data types in the data type table.

XBRLGetDataTypes — Returns a complete table of all data types.

XBRLGetFact — Returns the raw data for an XBRL fact or searches for the next matching item.

XBRLImportTaxonomy — Imports a taxonomy/schema.

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