Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5d

Application v 5.25a

  

 

Chapter Twenty-threeXBRL Functions (continued)

XBRLViewGetFactsByContext Function

Overview

The XBRLViewGetFactsByContext function returns all the facts for a specific context.

Syntax/Parameters

Syntax

string[] = XBRLViewGetFactsByContext ( handle hXBRL, string context );

Parameters

hXBRL

A handle containing the reference to an XBRL Object.

context

A string specifying the context for the facts.

Return Value

A string array containing each raw fact or an empty set on error. 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:

2 — Context not found.

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

Remarks

An empty string entry indicates a “nil” fact.

The facts may be arbitrarily ordered. Use the XBRLViewGetElementsByContext function to match the context IDs.

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

Related Functions

Platform Support

GoFiler Complete, GoFiler Corporate, GoXBRL