  |
GoFiler Legato Script Reference
Legato v 1.5b Application v 5.24b
|
| Table of Contents | < < Previous | Next >> |
Chapter Eleven — SGML Functions (continued)
Overview
The XBRLGetLabel function returns a label’s properties as specified by sorted order position or found by concept or concept and role.
Syntax/Parameters
Syntax
string[] = XBRLGetLabel ( handle hXM, int position );
string[] = XBRLGetLabel ( handle hXM, string concept, [string role] );
Parameters
hXM
A handle to an XBRL Object containing taxonomy information.
position
A zero-based int specifying the sequential position of the record in the sorted label table. Or,
concept
A string specifying the concept name to locate. This must match the concept exactly.
role
An optional string specifying the role. If provided, the concept and role must match exactly. See remarks about the role parameter.
Return Value
Returns a string list of label properties or an empty array on failure. Use the GetLastError function to retrieve a formatted error code.
On success, the last error will contain the position within the label table that the label was found at.
Remarks
The taxonomy must have been post processed using the XBRLPostProcess to use this function.
The find uses a fast binary search to locate an exact record. If only a concept is searched for, the returned position will be the first matching concept and can then be used to enumerate each role entry until the end of the label list is reached or the concept name changes.
A URI or URL can be provided as an optional role value. If the role parameter does not contain a path delimiter, it is treated as a role URI. Note that the URI under some taxonomies may not be unique. For exampe:
list = XBRLGetLabel(hXBRL, "AccretionExpense", "documentation");
The list employs the key names specified at Section 11.20.17 Taxonomy — Labels.
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.