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

Table of Contents	< < Previous	Next >>

 

Chapter Eleven — SGML Functions (continued)

XBRLGetReferenceArcs Function

Overview

The XBRLGetReferenceArcs function returns reference arcs present in the instance/taxonomy.

Syntax/Parameters

Syntax

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

Parameters

hXM

A handle to an XBRL Object containing instance information.

Return Value

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

Remarks

The primary column key names are as follows (not that other key names may be present since this is a generic arc structure): 

	Key Name			Description/Comment
	Arc Record:
		arcrole		The arcrole 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.
		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.
	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 of opening tag.
		o_sy		Zero-based Y position in source file of opening tag.
		ref_cnt		Number of arc references.
		arc_flags		A string as a hexadecimal value for the status of the entry.

 .

If all arcs are requested, there will be null records that delineate the break points in the list between presentation links. the arc_flags column will have the XM_ARC_NULL_RECORD bit set.

Related Functions

XBRLGetReference — Returns the properties for a specified reference (reference item).

XBRLGetReferenceCount — Returns a count of all references.

XBRLGetReferenceData — Returns the data elements for a specified reference.

XBRLGetReferenceLink — Returns a specified reference link.

XBRLGetReferenceLinkCount — Returns the number of items in the reference link table.

XBRLGetReferenceLinks — Returns all the reference links.

XBRLGetReferenceLocators — Returns all reference locators.

XBRLGetReferences — Returns all references or only those items associated with a specified concept.

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.