Sys2FormatNumber: Difference between revisions
m Ak120 moved page RxUtilEx - Sys2FormatNumber to Sys2FormatNumber |
mNo edit summary |
||
| Line 1: | Line 1: | ||
Formats a number to use thousands-grouping characters. The system values for the current locale are used for the thousands-grouping character and the decimal place, if any. Note that the IBM C runtime's built-in locale definitions are used; these may not correspond precisely to the system locales as defined in the OS/2 Locale object. | Formats a number to use thousands-grouping characters. The system values for the current locale are used for the thousands-grouping character and the decimal place, if any. Note that the IBM C runtime's built-in locale definitions are used; these may not correspond precisely to the system locales as defined in the OS/2 Locale object. | ||
The input number may be a positive or negative integer or floating point value. | The input number may be a positive or negative integer or floating point value. It must be a simple, non-localized number value; in other words, it must not contain any thousands-grouping characters, and any decimal point which it contains must be a period (rather than any localized decimal symbol). | ||
==Arguments== | ==Arguments== | ||
# Number to be formatted. (REQUIRED) | |||
# Number of decimal places to use for floating point values. Ignored for integer values. (DEFAULT: 2) | |||
==Return Value== | |||
The formatted number, or '' on error. | |||
[[Category:RxUtilEx]] | [[Category:RxUtilEx]] | ||
Latest revision as of 06:11, 3 May 2020
Formats a number to use thousands-grouping characters. The system values for the current locale are used for the thousands-grouping character and the decimal place, if any. Note that the IBM C runtime's built-in locale definitions are used; these may not correspond precisely to the system locales as defined in the OS/2 Locale object.
The input number may be a positive or negative integer or floating point value. It must be a simple, non-localized number value; in other words, it must not contain any thousands-grouping characters, and any decimal point which it contains must be a period (rather than any localized decimal symbol).
Arguments
- Number to be formatted. (REQUIRED)
- Number of decimal places to use for floating point values. Ignored for integer values. (DEFAULT: 2)
Return Value
The formatted number, or on error.