Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.4j

Application v 5.22b

  

 

Chapter FiveGeneral Functions (continued)

FormatNumberWithComma Function

Overview

The FormatNumberWithComma converts a string containing a flat number to one formatted with commas (US formatting).

Syntax/Parameters

Syntax

string = FormatNumberWithComma ( string value );

Parameters

value

A string containing a flat number.

Return Value

Returns a string containing the formatted number or an empty string on failure. Use the GetLastError function to retrieve error information.

Remarks

The FormatNumberWithComma function stops applying formatting to the string once a decimal point (‘.’) is reached. Any characters aside from numeric digits and decimal points will cause the FormatNumberWithComma function to fail. The function does not support negative numbers nor does it check the validity of the number. If the string parameter cannot be formatted with commas, the GetLastError function will return ERROR_SYNTAX.

Related Functions

Platform Support

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

Legato IDE, Legato Basic