Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.4j

Application v 5.22b

  

 

Chapter Twenty-threeXBRL Functions (continued)

XBRLViewGetFact Function

Overview

The XBRLViewGetFact function returns a string containing the raw fact data as specified by an element and a context.

Syntax/Parameters

Syntax

string = XBRLViewGetFact ( handle hXBRL, string element, string context );

Parameters

hXBRL

A handle containing the reference to an XBRL Object.

element

A string specifying the element for the fact. The element must contain the namespace designator. For example, “Assets” must be “us-gaap:Assets”.

context

A string specifying the context ID.

Return Value

A string containing the raw fact or an empty string on error. An empty string can indicate a “nil” fact so the error condition must be tested to differentiate between an empty position and a nil fact. Use the GetLastError function to retrieve a formatted error code or IsError / IsNotError to determine if an error occurred.

The ERROR_EOD (0x81000000) contains three variations to differentiate between errors:

0 — Empty fact position.

1 — Element not found.

2 — Context not found.

The ERROR_NONE_MASK can be ANDed to the value to determine which error occurred.

Remarks

Certain fact types such as text can be very large (up to 2MB).

Related Functions

Platform Support

GoFiler Complete, GoFiler Corporate, GoXBRL