IXTLRuntime::formatNumber Method

---

Formats the supplied number using the specified format.

Visual Basic Syntax

strValue = oXTLRuntime.formatNumber(dblNumber, bstrFormat)

C/C++ Syntax

HRESULT formatNumber(
    double dblNumber,
    BSTR bstrFormat,
    BSTR *pbstrFormattedString);

Parameters

dblNumber

[in] Number to be formatted.

bstrFormat

[in] Formatting characteristics to be applied to the number. Zero or more of the following values can be present:

#

Display only significant digits; do not display insignificant zeros.

0 (zero)

Display insignificant zeros if a number has fewer digits than there are zeros in the format.

?

Add spaces for insignificant zeros on either side of the decimal point, so that decimal points align with a fixed-point font. You can also use this symbol for fractions that have varying numbers of digits.

.

Indicate the placement of the decimal point within the format.

,

Display a comma as a thousands separator or scale a number by a multiple of one thousand.

%

Display number as a percentage of 100.

E-

(Also "e-") Display number in scientific format (exponential notation). If a format contains a zero (0) or number sign (#) to the right of an exponent code, display the number in scientific format and insert an "E" or "e." The number of zeros or number signs to the right determines the number of digits in the exponent. Place a minus sign by negative exponents.

E+

(Also "e+") Place a minus sign by negative exponents and a plus sign by positive exponents.

pbstrFormattedString

[out] String containing the formatted number.

C/C++ Return Value

Returns S_OK if successful, or an error code otherwise.