Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.4j

Application v 5.22b

  

 

Chapter ElevenSGML Functions (continued)

XBRLGetConcept Function

Overview

The XBRLGetConcept function returns a concept by position or name as specified in the taxonomy.

Syntax/Parameters

Syntax

string[] = XBRLGetConcept ( handle hXM, int position | string name );

Parameters

hXM

A handle to an XBRL Object containing taxonomy data..

position

A zero based int value specifying the concept to retrieve. Or,

name

A string containing a concept name. The value is case-sensitive.

Return Value

Returns a string list of concept properties or an empty array on failure. Use the GetLastError function to retrieve a formatted error code.

On success, the last error will context the position of the concept in the concept table. This can be used to reference adjoining concepts.

Remarks

The list employs the key names specified at Section 11.20.13 Taxonomy — Concepts.

Concepts are defined by the taxonomy. If called after post processing without loading the taxonomy, only a limited amount of data will be provided as determined by the referencing facts and contexts.

After loading a taxonomy or post processing an instance, the concepts list is sorted by the name. Names are case-sensitive.

When searching by name, the search is performed as a fast binary search.

If a qualifier is required (QName), the index position should be used to move down the list to locate the specific concept record.

Related Functions

Platform Support

Go13, Go16, GoFiler Complete, GoFiler Corporate, GoFiler, GoFiler Lite, GoXBRL

Legato IDE, Legato Basic