Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5d

Application v 5.25a

  

 

Chapter ElevenSGML Functions (continued)

XBRLGetDefinitionLink Function

Overview

The XBRLGetDefinitionLinks function returns a specified definition link from the instance/taxonomy.

Syntax/Parameters

Syntax

string[] = XBRLGetDefinitionLinks ( handle hXM, int index );

Parameters

hXM

A handle to an XBRL Object containing taxonomy information.

index

A zero-based int specifying the position to retrieve.

Return Value

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

Remarks

The key names are as follows: 

  Key Name   Description/Comment  
           
  Definition Link:      
    id   The id attribute, if supplied.  
    role   The role format the presentation  
    title   The tittle attribute.  
    type   The type of presentation  
  Inter-record Links      
    f_loc_index   Zero-based decimal string version of the first position of the locator records.  
    f_arc_index   Zero-based decimal string version of the first position of the arc records.  
  Control      
    position‡   The zero based position within the definition link table.  
    s_dx‡   Source file DTS index. String is “-1” if not from the DTS.  
    s_lx‡   Source file linkbase index. String is “-1” if not from the Linkbase List.  
    s_sx‡   Zero-based X position in source file.  
    s_sy‡   Zero-based Y position in source file.  
    ref_cnt   Number of link references.  
    dl_flags   A string as a hexadecimal value for the status of the entry.  

 

† This value is not presented in terse mode.  

This function is the same as XBRLGetDefinitionLinks except a single item is returned.

Related Functions

Platform Support

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

Legato IDE, Legato Basic