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

Table of Contents	< < Previous	Next >>

 

Chapter Eleven — SGML Functions (continued)

XBRLGetReferenceLink Function

Overview

The XBRLGetReferenceLink function returns a single reference link present in the instance/taxonomy.

Syntax/Parameters

Syntax

string[][] = XBRLGetReferenceLink ( handle hXM, int pos );

Parameters

hXM

A handle to an XBRL Object containing instance/taxonomy information.

pos

An optional int specifying the zero-based index of a reference link.

Return Value

Returns a string list of the properties for a reference link or an empty list on failure. Use the GetLastError function to retrieve a formatted error code.

Remarks

Reference links group together links within various linkbases.

The list key names are as follows: 

	Key Name			Description/Comment
	Presentation Link:
		id		The id attribute, if supplied.
		role		The role format the presentation
		title		The tittle attribute.
		type		The type of presentation
	Inter-record Links
		f_loc_index		Zero-based decimal string version of the first position of the locator records.
		f_arc_index		Zero-based decimal string version of the first position of the arc records.
		f_reference_index		Zero-based decimal string version of the first position of the reference item records.
	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.
		s_sx†		Zero-based X position in source file.
		s_sy†		Zero-based Y position in source file.
		ref_cnt		Number of link record references (not XBRL references).
		pl_flags		A string as a hexadecimal value for the status of the entry.

 

† This value is not presented in terse mode.  

[define flags]

Related Functions

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

XBRLGetReferenceArcs — Returns all the reference arcs.

XBRLGetReferenceCount — Returns a count of all references.

XBRLGetReferenceData — Returns the data elements for a specified reference.

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.

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.