Legato
Legato

GoFiler Script Reference

 

Legato v 1.3n

Application v 5.16a

  

 

Chapter ElevenSGML Functions (continued)

XBRLGetUnit Function

Overview

The XBRLGetUnit function returns a unit definition’s properties as specified by sorted order position or found by concept or concept and role.

Syntax/Parameters

Syntax

string[] = XBRLGetUnit ( handle hXM, int position);

string[] = XBRLGetUnit ( handle hXM, string id );

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 unit table. Or,

id

A string specifying the unit id to locate. This must match the id exactly.

Return Value

Returns a string list of unit 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 unit table was found at.

Remarks

The find uses a fast binary search to locate an exact record.

The list employs the key names specified at Section 11.17.16 Unit Functions.

Related Functions

Platform Support

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

Legato IDE, Legato Basic