  |
GoFiler Legato Script Reference
Legato v 1.5b Application v 5.24b
|
| Table of Contents | < < Previous | Next >> |
Chapter Eleven — SGML Functions (continued)
Overview
The XBRLGetConcepts function returns a list of concepts filtered by concept, role or language.
Syntax/Parameters
Syntax
string[][] = XBRLGetConcepts ( handle hXM, [string filters[]], [dword nocase] );
Parameters
hXM
A handle to an XBRL Object containing taxonomy data.
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 concepts 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 concept properties or an empty array on failure. Use the GetLastError function to retrieve a formatted error code.
Remarks
Each matching item is placed in the resulting table as a row with named columns for each concept. The column employs the key names specified at Section 11.20.13 Taxonomy — Concepts.
The filters use the following key names (a subset of the returned column key names:
id — Internal concept ID (used for cross reference).
name — Name of the concept.†
uri — Namespace URL.
prefix — Prefix portion of the QName (this only applies to a loaded instance).
abstract — If specified, match abstract attribute.*
nillable — If specified, match abstract attribute.*
period_type — If specified, matches the period type.‡
balance_type — If specified, matches the period type.‡
is_referenced — If specified, the tests concept for being referenced.*
is_fact_referenced — If specified, the tests concept for having a fact reference.*
is_con_reference — If specified, the tests concept for having a context reference.*
is_cal_referenced — If specified, the tests concept for having a calculation reference.*
is_def_referenced — If specified, the tests concept for having a definition reference.*
is_lab_referenced — If specified, the tests concept for having a label reference.*
is_pre_referenced — If specified, the tests concept for having a presentation reference.*
is_ref_referenced — If specified, the tests concept for having a reference reference.*
† This is not an optimal function to look for a specific concept unless using wild cards.
‡ Not subject to case matching.
* Using a True or False will match presence or absence of the condition. Omitting passes either case.
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 the filter is case-sensitive.
XBRLGetConcepts will scan the entire database of concepts to provide the filtered data set. As such, do not use this function to locate a specific concept by name, rather use the XBRLGetConcept function. XBRLGetConcept performs a fast binary search thus reducing the number of search iterations dramatically.
If there are no matching items, an empty array is returned.
Certain filters, such as is_reference, require the instance and taxonomy to be post processed using the XBRLPostProcess function.
Certain filters, such as is_reference, require the loaded model to be an instance instance.
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.