  |
GoFiler Legato Script Reference
Legato v 1.6c Application v 6.1a
|
| Table of Contents | < < Previous | Next >> |
Chapter Eleven — SGML Functions (continued)
XBRLGetDefinitionLocators Function
Overview
The XBRLGetDefinitionLocators function returns a table of all the definition locators in the specified taxonomy/instance.
Syntax/Parameters
Syntax
string[][] = XBRLGetDefinitionLocators ( handle hXM, [int link] );
Parameters
hXM
A handle to an XBRL Object containing taxonomy information.
link
An optional int specifying the zero-based starting position to start returning locators.
Return Value
Returns a string table of the definition locators 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 | ||||
| Locator Record: | |||||
| href | Reference ID for the associated concept. | ||||
| label | Reference to one or more arcs. | ||||
| Control | |||||
| uri | Source file uri for the locator. | ||||
| 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. | ||||
| loc_flags | A string as a hexadecimal value for the status of the entry. | ||||
† This value is not presented in terse mode.
Locator Flags (loc_flags):
| Definition | Bitwise | Description | |||||
| XM_LOCATOR_ERROR_MASK | 0x0000FFFF | Mask for Error Bits | |||||
| XM_LOCATOR_HREF_SYNTAX_ERROR | 0x00000001 | 'href' Syntax Error | |||||
| XM_LOCATOR_HREF_NOT_FOUND | 0x00000002 | Could not Find Reference ID | |||||
| XM_LOCATOR_DUPLICATE_CONTENT | 0x00000004 | Duplicate Content | |||||
| XM_LOCATOR_ID_NOT_FOUND | 0x00000008 | Could Not Find Concept/Fact/Item | |||||
| XM_LOCATOR_LABEL_NOT_FOUND | 0x00000010 | Could Not Find Associaed Arc | |||||
| XM_LOCATOR_INCORRECT_CONTEXT | 0x00000020 | 'href' Points to Incorrect Type | |||||
| XM_LOCATOR_NULL_RECORD | 0x00010000 | Null Record/Marker | |||||
Locator records are set in load order with gaps between link groups. As such, locators can be dumped a complete table or in sections when a locator position is specified.
The first locator link can be accessed from the definition link data retrieved by the XBRLGetDefinitionLink or XBRLGetDefinitionLinks functions.
If all locators are requested, there will be null records that delineate the break points in the list between presentation links. the loc_flags column will have the XM_LOCATOR_NULL_RECORD bit set.
Related Functions
Platform Support
Go13, Go16, GoFiler Complete, GoFiler Corporate, GoFiler, GoFiler Lite, GoXBRL
Legato IDE, Legato Basic
Page revised 2025-06-16
| Table of Contents | < < Previous | Next >> |
© 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.