Format()

Summary

Formats a number.

Syntax

formatted_number = Format(real x, string format)

Returns

A string containing a formatted version of x.

Notes

• The format string and the returned string have three parts:

• • the part to the left of the decimal,

  • the part to the right of the decimal, and

  • the part after the exponent indicator.

• Each part is formatted separately according to the following rules:

• • If part of the format string contains an asterisk (*), the corresponding part of the returned string contains as many digits as are necessary to represent that value.

  • Otherwise, that part of the returned string contains at least as many digits as there are zeros (0) in that part of the format string, and at most as many digits are there are zeros and number signs (#) in that part of the format string.

  • Zeros are significant digits and number signs are optional digits.

• If the format string contains an E, then x is formatted in scientific notation; otherwise, it is not. The case of the E in the returned string matches the case of the E in the format string.

• If the format string does not have any required digits to the right of the decimal, and x is an integer, then the decimal point is omitted from the returned string.

• If the format string contains a dollar sign ($), then the returned string begins with a dollar sign.

• If the format string contains a comma, then the part of the returned string to the left of the decimal has a comma every three digits. The comma and the period must be separated by an asterisk (*) or at least one zero or number sign.

• If the format string contains a percent sign (%), then x is multiplied by 100 before being formatted, and the returned string ends with a percent sign.

• If x contains more digits to the right of the decimal than are allowed for in the format string, Format() rounds them.

• If x contains more digits to the left of the decimal than are allowed for in the format string, then Format() overflows and returns a string consisting only of number signs (#).

• If the format string contains the letter i, then the roles of commas and periods in the output is reversed.

• If the format string contains a less-than sign (<), then the returned string begins with the text leading up to the less-than sign.

• If the format string contains a greater-than sign (>), then the returned string ends with the text after the greater-than sign.

Example

See Also