Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5b

Application v 5.24b

  

 

Chapter Eleven — SGML 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

XBRLGetRole — Returns a specified role by index or searches by role id.

XBRLGetRoleCount — Returns the count of all defined roles.

XBRLLoadInstance — Maps and loads the model and returns a handle to an XBRL Object.

XBRLLoadTaxonomy — Load and associated or specified taxonomy.

XBRLSetOptions — Set processing, data and reporting options.

Platform Support

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

Legato IDE, Legato Basic

 

GoFiler Legato Script Reference — Generated on 10/21/2024

© 2012-2024 Novaworks, LLC. All rights reserved worldwide. Unauthorized use, duplication or transmission prohibited by law. Portions of the software are protected by US Patents 10,095,672, 10,706,221 and 11,210,456. GoFiler™ and Legato™ are trademarks of Novaworks, LLC. EDGAR® is a federally registered trademark of the U.S. Securities and Exchange Commission. Novaworks is not affiliated with or approved by the U.S. Securities and Exchange Commission. All other trademarks are property of their respective owners. Use of the features specified in this language are subject to terms, conditions and limitations of the Software License Agreement.