Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5b

Application v 5.24b

  

 

Chapter ElevenSGML Functions (continued)

XBRLGetLinkbaseList Function

Overview

The XBRLGetLinkbaseList function returns a table of linkbases discovered during the XBRL or Taxonomy load process.

Syntax/Parameters

Syntax

string[][] = XBRLGetLinkbaseList ( handle hXM );

Parameters

hXM

A handle to an XBRL Object.

Return Value

Returns a string table of namepsaces or an empty array on failure. Use the GetLastError function to retrieve a formatted error code.

Remarks

Linkbases are the associated data lists such as labels, calculations, presentations, etc... Some linkbases are not loaded as they support XBRL and are not germane to the actual taxonomy.

Each column has the following key names:

  Key Name   Description/Comment  
         
  type   A string in hexadecimal format representing the linkbase type.  
  href   The location of the linkbase. May or may not be qualified.  
  role   The linkbase role as a string.  
  role_token   The linkbase role as a token.  
  arcrole   Associated arcrole.  
  status   A string in hexadecimal format representing the item status flags.  
  base   Reference base path to qualify the href.  
  q_href   Qualified href.  

Status flags are as follows: 

  Name   Bitwise   Description/Comment  
             
  XM_LB_ERROR_MASK   0x00000FFF   Mask for Windows (File) Error Code.  
  XM_LB_IGNORE   0x00010000   This item was ignored.  
  XM_LB_ERROR   0x00020000   There was an error loaded.  
  XM_LB_LOADED   0x00040000   Item is loaded.  

 

Related Functions

Platform Support

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

Legato IDE, Legato Basic