  |
GoFiler Legato Script Reference
Legato v 1.5b Application v 5.24b
|
| Table of Contents | < < Previous | Next >> |
Chapter Eleven — SGML Functions (continued)
XBRLGetDefinitionLocator Function
Overview
The XBRLGetDefinitionLocator function returns a specified definition locator record in the specified taxonomy/instance.
Syntax/Parameters
Syntax
string[][] = XBRLGetDefinitionLocators ( handle hXM, int index );
Parameters
hXM
A handle to an XBRL Object containing taxonomy information.
index
An int specifying the zero-based position of the locator record.
Return Value
Returns a string array of the definition locator or an empty array on failure. Use the GetLastError function to retrieve a formatted error code.
Remarks
The key names are as follows:
| Key Name | Description/Comment | ||||
| Locator Record: | |||||
| href | Reference ID for the fact. | ||||
| label | Reference to one or more arcs. | ||||
| Control: | |||||
| position† | The zero based position within the definition link table. | ||||
| 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.
The first locator link can be accessed from the definition link data retrieved by the XBRLGetDefinitionLink or XBRLGetDefinitionLinks functions.
Related Functions
Platform Support
Go13, Go16, GoFiler Complete, GoFiler Corporate, GoFiler, GoFiler Lite, GoXBRL
Legato IDE, Legato Basic
| Table of Contents | < < Previous | Next >> |
© 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.