GoFiler Legato Script Reference   Legato v 1.4j Application v 5.22b

Table of Contents	< < Previous	Next >>

 

Chapter Eleven — SGML Functions (continued)

XDXGetEngram Function

Overview

The XDXGetEngram function returns the raw engram as a specified map position.

Syntax/Parameters

Syntax

string = XDXGetEngram ( handle hXDX, int index );

Parameters

hXDX

A handle to an XDX Object.

index

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

Return Value

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

Remarks

Once retrieved, the raw engram can be cracked into parameters using the XDXEngramToParameters function. The parameters, or components can be further refined by use individual functions to get the properties of each item.

Many property items will also accept the complete engram as a source parameter.

Engram Format

xdx_ffc[_param 1, ...]

Where:

	xdx	Designates ID as an XDX engram.
	ff	Defines the engram type
	c	Is a check code to verify the integrity of the overall engram.
	param	Is any associated data. Engrams can have up to twenty (20) parameters.

 

Related Functions

XDXEngramToParameters — Parses an engram and breaks it in to its constituent parameters.

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

XDXGetCalculationProperties — Extracts calculation data from a component or engram.

XDXGetContextProperties — Extracts context properties from an engram or component.

XDXGetDisplayFlags — Extracts the display flags from an engram or component.

XDXGetDisplayProperties — Extracts the display properties from an engram or component.

XDXGetElement — Extracts an element from an engram or component.

XDXGetEngramCount — Returns the current count in the engram map.

XDXGetEngramPosition — Returns the file position of a mapped engram.

XDXGetEngramType — Retrieves the engram type from a string or map entry.

XDXGetGroupingProperties — Extracts grouping properties from engram or component.

XDXGetPrecisionProperties — Extracts precision properties from engram or component.

XDXGetPresentationProperties — Extracts presentation formation for one or more facts from engram or component.

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 04/22/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.