Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5d

Application v 5.25a

  

 

Chapter ElevenSGML Functions (continued)

SGMLNormalizeUnits Function

Overview

The SGMLNormalizeUnits function normalizes a specified value to be in the same units as another value.

Syntax/Parameters

Syntax

PVALUE = SGMLNormalizeUnits ( PVALUE value, PVALUE units );

Parameters

value

A PVALUE (dword) specifying a structured parameter value. If the value is provided as a raw integer, it will be treated as PT_INT unless it is negative in which case an error will be returned.

units

A PVALUE (dword) specifying the new units to translate as the result. Any value data is stripped.

Return Value

A PVALUE (dword) as the result or PR_UNTRANSLATED on error. The GetLastError function will return ERROR_SYNTAX on error.

Remarks

This function translates to TWIPS and then to destination to perform normalization and therefore has a maximum resolution of 1/20th of a point.

Related Functions

Platform Support

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

Legato IDE, Legato Basic