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

Table of Contents	< < Previous	Next >>

 

Chapter Eleven — SGML Functions (continued)

XDXGetUnitProperties Function

Overview

The XDXGetUnitProperties function extracts the unit ID from a component or engram.

Syntax/Parameters

Syntax

string[] = XDXGetUnitProperties ( string data );

Parameters

data

A string containing an engram or the precision component of an engram.

Return Value

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

Remarks

This function disassembles an XDX unit component which describes part of an iXBRL unit.

XDX component formatting for this parameter are as follows:

uID

where:

ID

An identifier for the unit. This ID is also used for the final unit table as part of the XBRL instance.

Examples:

uPure

The returned data is in the form of an array to allow for later expansion of properties, if necessary.

This function is the reciprocal of XDXCreateUnitComponent.

Related Functions

XDXCreateUnitComponent — Creates a component string for unit ID information.

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

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

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.

XDXGetGroupingProperties — Extracts grouping 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 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.