Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5b

Application v 5.24b

  

 

Chapter ElevenSGML Functions (continued)

XBRLGetFootnote Function

Overview

The XBRLGetFootnote function returns a specific footnote’s properties as specified by sorted order position or found by concept or concept and role.

Syntax/Parameters

Syntax

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

string[] = XBRLGetFootnote ( handle hXM, string label, [string language] );

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

label

A string specifying the footnote label (ID) to locate. This must match the label exactly.

lnguage

An optional string specifying a language code. If provided, the label and the language must match exactly.

Return Value

Returns a string list of footnote 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 footnote table that the label/language was found at.

Remarks

The find uses a fast binary search to locate an exact record. If only a label is searched for, the returned position will be the first matching label and can then be used to enumerate each language entry until the end of the footnote list is reached or the label changes.

The list employs the key names specified at Section 11.20.12 Instance — Footnotes.

Related Functions

Platform Support

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

Legato IDE, Legato Basic