GoFiler Legato Script Reference   Legato v 1.5b Application v 5.24b

Table of Contents	< < Previous	Next >>

 

Chapter Eleven — SGML Functions (continued)

XBRLGetRole Function

Overview

The XBRLGetRole function returns a record from the table of roles discovered during the Taxonomy load process.

Syntax/Parameters

Syntax

string[] = XBRLGetRole ( handle hXM, int index | string id );

string[] = XBRLGetRole ( handle hXM, int index );

Parameters

hXM

A handle to an XBRL Object.

index

An int specifying the zero-based index to the role table. when used, the id parameter cannot be used.

id†

An string specifying an identifier to find in the role table. when used, the index parameter cannot be used.

Return Value

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

Remarks

The returned list 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

XBRLGetRoleCount — Returns the count of all defined roles.

XBRLGetRoleList — Returns the list of roles defined within the taxonomy.

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

 

Table of Contents	< < Previous	Next >>

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.