Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.4j

Application v 5.22b

  

 

Chapter ElevenSGML Functions (continued)

XBRLGetRoleList Function

Overview

The XBRLGetRoleList function returns a table of roles discovered during the Taxonomy load process.

Syntax/Parameters

Syntax

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

Parameters

hXM

A handle to an XBRL Object.

Return Value

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

Remarks

Each column has the following key names:

  Key Name   Description/Comment  
           
  Item Record:      
    role   Predefined Role Token in hexadecimal. Zero if not set.  
    role_uri   URI defining the role.  
    role_id   Unique ID for the role.  
    definition   Text describing the role.  
    used_on   Linkbase name or code to be used on.  
  Control      
    s_dx†   Source file DTS index. String is “-1” if not from the DTS.  
    s_lx†   Source file linkbase index. String is “-1” if not from the Linkbase List.  
    o_sx†   Zero-based X position in source file.  
    o_sy†   Zero-based Y position in source file.  

 

† This value is not presented in terse mode.

Related Functions

Platform Support

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

Legato IDE, Legato Basic