GoFiler Legato Script Reference   Legato v 1.6c Application v 6.1a

Table of Contents	< < Previous	Next >>

 

Chapter Eleven — SGML Functions (continued)

XBRLGetConceptByLocator Function

Overview

The XBRLGetConceptByLocator function returns a concept by locator label.

Syntax/Parameters

Syntax

string[] = XBRLGetConceptByLocator ( handle hXM, string label, [dword flags] );

Parameters

hXM

A handle to an XBRL Object containing taxonomy data..

label

A string containing a locator label. The value is case-sensitive.

flags

An optional dword specifying the locator linkbases to search. If omitted, the default is to search all locators lists.

Return Value

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

On success, the last error will context the position of the concept in the concept table.

Use the GetLastErrorMessage to obtain additional textual information.

Remarks

The XBRLGetConceptByLocator function searches one or more linkbase locator lists to locate the specified label. Upon success, the href from the locator is used then search the concept table for a matching ID in the for the specified url/uri.

Labels should be unique, but the search can be narrowed using the flags as follows:

	Definition			Bitwise		Description
		XM_GCL_ALL		0x0000FFFF		Look at all the Locator List
		XM_GCL_CALCULATION		0x00000001		Calculation Locator Array
		XM_GCL_DEFINITION		0x00000004		Definition Locator Array
		XM_GCL_FOOTNOTE		0x00000010		Footnote Locator Array
		XM_GCL_LABEL		0x00000040		Label Locator Array
		XM_GCL_PRESENTATION		0x00000100		Presentation Locator Array
		XM_GCL_REFERENCE		0x00000400		Reference Locator Array

 

The list employs the key names specified at Section 11.20.14 Taxonomy — Concepts.

Related Functions

XBRLAddConcept — Adds a concept to the concept data.

XBRLGetCalculationLocators

XBRLGetConcept — Returns all the properties associated for a specified concept.

XBRLGetConcepts — Returns all the properties associated with all concepts.

XBRLGetDefinitionLocator — Returns a specified definition locator.

XBRLGetDefinitionLocators — Returns all the definition locators.

XBRLGetFootnoteLocators — Returns all footnote locators.

XBRLGetPresentationLocators — Returns all presentation locators.

XBRLGetReferenceLocators — Returns all reference locators.

XBRLLoadTaxonomy — Load and associated or specified taxonomy.

Platform Support

Go13, Go16, GoFiler Complete, GoFiler Corporate, GoFiler, GoFiler Lite, GoXBRL

Legato IDE

Page revised 2025-06-16

 

Table of Contents	< < Previous	Next >>

GoFiler Legato Script Reference — Generated on 06/16/2025

© 2012-2025 Novaworks, LLC. All rights reserved worldwide. Unauthorized use, duplication or transmission is prohibited by law. Portions of the software are protected by US Patents 10,095,672, 10,706,221 and 11,210,456. Novaworks, GoFiler™ and Legato™ are registered 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 the 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.