Legato
Legato

GoFiler Script Reference

 

Legato v 1.3n

Application v 5.16a

  

 

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

The default Data Type Table is loaded with the XBRL DTR, XML Types, SEC DEI Types, SEC SRT Types for various years.

Related Functions

Platform Support

Go13, Go16, GoFiler Complete, GoFiler Corporate, GoFiler, GoXBRL

Legato IDE, Legato Basic