Format   built-in function

The Format function formats a numeric value.

result = Format( number [, [ before ] [, [ after ] [, [ expp ] [, [ expt ] ] ] ] )

number

the numeric value to format.

before

the number of characters prior to the decimal point. If this is omitted, as many digits as necessary will appear. If the before value is insufficient to prepare the leading integer digits an error will occur.

after

the number of characters following to the decimal point. If after is smaller than the decimal portion of the number, the numeric value will be rounded to the appropriate number of places.

expp

the number of digits in the exponent part. If this is omitted, as many exponent digits as necessary will appear. If the expp value is insufficient to prepare exponent digits an error will occur.

If 0 is specified for the expp argument, the number will be formatted in simple form, with added zeroes as necessary.

expt

decimal numbers can be formatted in standard or exponential form. The default exponential formatting is based on the current setting of NUMERIC DIGITS. The type of formatting can be optionally controlled by the expt argument. When the number of places needed for the leading integer part exceeds expt, or the decimal part exceeds twice expt, then exponential form is used, otherwise standard form is used.

Examples: say Format( 7, 3 ) -- shows: ' 7' say Format( 7.11, 3, 1 ) -- shows: ' 7.1' say Format( 7.15, 3, 1 ) -- shows: ' 7.2' say Format( ' - 7.11' ) -- shows: '-7.11' say Format( 12345.73, , , 2, 2 ) -- shows: '1.234573E+04' say Format( 12345.73, , , 3, 6 ) -- shows: '12345.73' say Format( 1.234573, , 3, , 0 ) -- shows: '1.235' say Format( 123.45, , 3, 2, 0 ) -- shows: '1.235E+02'