Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5d

Application v 5.25a

  

 

Chapter ElevenSGML Functions (continued)

SGMLMultiplyValue Function

Overview

The SGMLMultiplyValue function multiplies a pvalue with a floating-point value and returns a pvalue.

Syntax/Parameters

Syntax

PVALUE = SGMLMultiplyValue ( PVALUE value, float multiplier );

Parameters

value

A PVALUE (dword) specifying a structured parameter value as a measurement.

multiplier

A float to multiply with the value portion of the value.

Return Value

A PVALUE (dword) with the result or PT_UNTRANSLATED on error. The GetLastError will return ERROR_SYNTAX on error.

The result will be of the same unit type as value.

Remarks

Use of non-measurement values will result in a undefined result.

The function does check for ranging and overflow.

Related Functions

Platform Support

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

Legato IDE, Legato Basic