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

Table of Contents	< < Previous	Next >>

 

Chapter Eleven — SGML Functions (continued)

XBRLGetReferenceData Function

Overview

The XBRLGetReferenceData function returns reference information associated with an reference item.

Syntax/Parameters

Syntax

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

Parameters

hXM

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

index

A string or an int specifying the zero-based index to start enumerating data.

Return Value

Returns a string table of the reference data associated with a reference item or an empty array on failure. Use the GetLastError function to retrieve a formatted error code.

Remarks

The column key names are as follows: 

	Key Name			Description/Comment
	Data Record:
		tag		The tag name (opening tag item) in the reference entry.
		content		The content of the entry.
	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.
		rd_flags		A string as a hexadecimal value for the status of the entry.

 

The value of f_data_index key points to the first reference data item,.

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.

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.