Changeset 21 for rxutilex/trunk/FUNCTIONS

Timestamp:

Oct 28, 2014, 12:30:20 PM (11 years ago)

Author:

Alex Taylor

Message:

Implemented Sys2FormatNumber() function.

File:

• rxutilex/trunk/FUNCTIONS (modified) (2 diffs)

rxutilex/trunk/FUNCTIONS

@@ -9 +9 @@
 Sys2DisconnectNamedPipe     - Acknowledge that a named pipe session has ended
 Sys2DropFuncs               - Deregister all functions
+Sys2FormatNumber            - Format a number with thousands-grouping characters
 Sys2FormatTime              - Format calender time (strftime wrapper)
 Sys2GetClipboardText        - Retrieve the current clipboard text
@@ -146 +147 @@
 REXX ARGUMENTS:    None
 REXX RETURN VALUE: ""
+
+
+-------------------------------------------------------------------------
+Sys2FormatNumber                                                         
+                                                                         
+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).
+                                                                         
+REXX ARGUMENTS:                                                          
+  1. Number to be formatted.                                  (REQUIRED) 
+  2. Number of decimal places to use for floating point values.  
+     Ignored for integer values.                            (DEFAULT: 2)
+                                                                         
+REXX RETURN VALUE: The formatted number, or '' on error.