Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5d

Application v 5.25a

  

 

Chapter FiveGeneral Functions (continued)

IntegerToOrdinal Function

Overview

The IntegerToOrdinal function converts an integer to a string containing an ordinal equivalent.

Syntax/Parameters

Syntax

string = IntegerToOrdinal ( int value, [boolean numeric] );

Parameters

value

An int.

numeric 

An optional boolean flag indicating whether to return numeric results. For example, “1st” rather than “first”. The default is textual or FALSE.

Return Value

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

Remarks

The IntegerToOrdinal function converts an integer to ordinal test (such as 11 to “eleventh”, 101 to “one hundred first”) or an ordinal number (such as “2nd” or “103rd”). Negative numbers are not permitted and the routine only runs to 999. If the integer parameter cannot be converted to ordinal text, the GetLastError function will return ERROR_OVERFLOW.

Related Functions

Platform Support

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

Legato IDE, Legato Basic