GoFiler Script Reference   Legato v 1.3n Application v 5.16a

Table of Contents	< < Previous	Next >>

 

Chapter Eleven — SGML Functions (continued)

XBRLGetDefinitionArcs Function

Overview

The XBRLGetDefinitionArcs function returns a table of defined definition arcs for the loaded linkbase.

Syntax/Parameters

Syntax

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

Parameters

hXM

A handle to an XBRL Object containing taxonomy information.

Return Value

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

Remarks

Arcs connect labels to specific elements.

The column key names are as follows: 

	Key Name			Description/Comment
	Arc Record:
		arcrole		The arcrole attribute.
		context_element		The contextElement attribute.
		from		The from attribute label to the arc. This is the link from the locator to the arc.
		order		The order attribute. Decimal with two places.
		closed		The closed attribute, “true”, “false” or empty string.
		priority		The priority attribute.
		show		The show attribute.
		title		The tittle attribute.
		to		The to attribute as the label used to link the arc to an actual footnote record.
		use		The use attribute.
	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		Position in source file.
		o_sy		Position in source file.
		ref_cnt		Number of arc references.
		arc_flags		A string as a hexadecimal value for the status of the entry.

 

Related Functions

XBRLGetDefinitionLink — Returns a specified the definition link.

XBRLGetDefinitionLinkCount — Returns the number of items in the definition link table.

XBRLGetDefinitionLinks — Returns all the definition links.

XBRLGetDefinitionLocators — Returns all the definition locators.

Platform Support

GoFiler Complete

Legato IDE, Legato Basic

 

Table of Contents	< < Previous	Next >>

GoFiler Legato Script Reference — Generated on 09/19/2022

© 2007-2022 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.