Click or drag to resize

_Str3 Function

Convert a numeric expression to a string of specific length and decimal places.

Namespace:  XSharp.RT
Assembly:  XSharp.RT (in XSharp.RT.dll) Version: 2.10
Syntax
 FUNCTION _Str3(
	f AS FLOAT,
	dwLen AS DWORD,
	dwDec AS DWORD
) AS STRING
View Source

Parameters

f
Type: Float
dwLen
Type: UInt32
dwDec
Type: UInt32

Return Value

Type: String
A string with DOT as decimal separator.
Remarks
Str3() is a typed version of the Str() numeric function where all three arguments are mandatory.  See Str() for a detailed description.
Examples
These examples show how to use Str3() to change a number to a string:
X#
LOCAL fNumber AS FLOAT
fNumber := 123.45
? Str3(fNumber, 10, 1)                        //      123.5
? Str3(fNumber * 10, 7, 2)                // 1234.50
? Str3(fNumber * 10, 12, 4)                //    1234.5000
This functions returns a string of all asterisks when the Decimals parameter is > 0 and the Decimals parameter is  > Length-2. Also a string of all asterisks is returned when the number does NOT fit into the allocated space. Example:
X#
? Str(9,6,6)        => "******"
? Str(9,6,5)        => "******"
? Str(9,6,4)        => "9.0000"
? Str(9,6,3)        => " 9.000"
? Str(10,6,6)        => "******"
? Str(10,6,5)        => "******"
? Str(10,6,4)        => "******"
? Str(10,6,3)        => "10.000"
See Also