GoFiler Legato Script Reference   Legato v 1.5b Application v 5.24b

Table of Contents	< < Previous	Next >>

 

Chapter Eleven — SGML 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 index );

Parameters

data

A string containing an engram. Or,

hXDX

A handle to an XDX Object. And,

index

A zero-based int specifying the map index 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		Two digit zero-based index value of the parameter.

 

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

Related Functions

XDXEngramToProperties — Parses an engram and returns the high-level associated XBRL properties.

XDXGetElement — Extracts an element from an engram or component.

XDXGetEngram — Gets an engram at a specific position.

XDXGetEngramCount — Returns the current count in the engram map.

XDXMapArea — Maps an area of an existing item for XDX information.

XDXMapFile — Maps an existing item for XDX information.

XDXPropertiesToEngram — Creates an engram based on the specified properties.

Platform Support

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

Legato IDE, Legato Basic

 

Table of Contents	< < Previous	Next >>

GoFiler Legato Script Reference — Generated on 10/21/2024

© 2012-2024 Novaworks, LLC. All rights reserved worldwide. Unauthorized use, duplication or transmission prohibited by law. Portions of the software are protected by US Patents 10,095,672, 10,706,221 and 11,210,456. GoFiler™ and Legato™ are trademarks of Novaworks, LLC. EDGAR® is a federally registered trademark of the U.S. Securities and Exchange Commission. Novaworks is not affiliated with or approved by the U.S. Securities and Exchange Commission. All other trademarks are property of their respective owners. Use of the features specified in this language are subject to terms, conditions and limitations of the Software License Agreement.