Legato
Legato

GoFiler Script Reference

 

Legato v 1.3t

Application v 5.18a

  

 

Chapter Twenty-threeXBRL Functions (continued)

XDXEngramToParameters Function

Overview

The XDXEngramToParameters function returns an array of parameters as decoded from an engram.

Syntax/Parameters

Syntax

string[] = XDXEngramToParameters ( string data );

string[] = XDXEngramToParameters ( handle hXDX, int position );

Parameters

data

A string containing an engram. Or,

hXDX

A handle to an XDX Object. And,

position

A zero-based int specifying the map position to retrieve the data.

Return Value

A string array containing the parameters for the engram or an empty array on failure. Use the GetLastError function to retrieve a formatted error code and GetLastErrorMessage for additional detail.

Remarks

The XDXEngramToParameters takes an engram and breaks it into parameters. The first few parameters are always the same and they represent the type of engram and control information. The remaining contain the specific data for the engram, the content of which varies.

Data is returned in string form with numeric data as decimal or hexadecimal as required. The key names are as follows:

  Key Name   Description  
           
  Control Information:      
    code   The XDX code that specifies the function of the engram.  
    sx   Specifies the zero based starting position of parameter data.  
    delimiter   Specifies the delimiter in the form of a character and a hexadecimal byte code of the character. This is normally “_ 0x5F” unless that character is used within data.  
  Parameters:      
    p.nn.type   Type of parameter in the form of a 16-bit hexadecimal value.  
    p.nn.value    Data for the parameter in the form of a string.  
        -- nn   The zero-based index value of the parameter with a  
           

 

The XDXEngramToProperties function parses the parameters and returns XDX/XBRL data as a series of parameters.

Related Functions

Platform Support

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

Legato IDE, Legato Basic