  |
GoFiler Legato Script Reference
Legato v 1.5b Application v 5.24b
|
| Table of Contents | < < Previous | Next >> |
Chapter Eleven — SGML Functions (continued)
Overview
The XBRLGetLabels function returns a list of labels filtered by concept, role or language.
Syntax/Parameters
Syntax
string[][] = XBRLGetLabels ( handle hXM, [string filters[]], [dword nocase] );
Parameters
hXM
A handle to an XBRL Object containing taxonomy information.
filters
An optional string array specifying option filters as match strings. Each string can contain wildcard characters. Missing filters are treated as all or “*”. If the filters parameter is not provided, all labels are returned.
nocase
An optional dword, if set to TRUE forces all compares as case-insensitive. The default value is FALSE. This parameter can only be used if the filters parameter is provided.
Return Value
Returns a string table of label properties or an empty array on failure. Use the GetLastError function to retrieve a formatted error code.
Remarks
The taxonomy must have been post processed using the XBRLPostProcess to use this function.
Each matching item is placed in the resulting table as a row with named columns for each label. The column employs the key names specified at Section 11.20.17 Taxonomy — Labels.
The filters use the following key names (a subset of the returned column key names):
type — Role Type Code (not role name).
label_id — Label ID.
role_url — Qualified role URL.
language — Language code.
concept — Associated Concept.†
role_uri — Role URI (short name).
† This is not an optimal function to look for a specific concept unless using wild cards.
Using an incorrect filter key name will result in an ERROR_PARAMETER being returned. The last error message will contain the name of the key that failed. If a filter is not used, it can be omitted from the array. The value of each filter is case-sensitive.
XBRLGetLabels will scan the entire database of labels to provide the filtered data set. As such, do not use this function to locate a specific label by concept name, rather use the XBRLGetLabel function and either walk through the common items or filter further using the role qualifier. XBRLGetLabel performs a fast binary search thus reducing the number of search iterations dramatically.
If there are no matching items, an empty array is returned.
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.