Important:
This is retired content. This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This content may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist.
A version of this page is also available for
4/8/2010

Formats the number using the specified format.

Script Syntax

Copy Code 
		
strValue = oXTLRuntime.formatNumber(
dblNumber, 
bstrFormat);

Remarks

Script Parameters

dblNumber

Double. Number to be formatted.

bstrFormat

String. Specified formatting characteristics to be applied to the number. See Remarks.

Script Return Value

String. Returns a string containing the formatted number.

C/C++ Syntax

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

Remarks

C/C++ Parameters

dblNumber

[in] Number to be formatted.

bstrFormat

[in] Formatting characteristics to be applied to the number. See Remarks.

pbstrFormattedString

[out, retval] String containing the formatted number.

C/C++ Return Values

S_OK

Value returned if successful.

Requirements

Header msxml2.h, msxml2.idl
Library uuid.lib
Windows Embedded CE Windows CE .NET 4.0 and later

General Remarks

Specified formatting characteristics that are applied to the number. Zero or more of the following values can be present.

#

Display only significant digits; does 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 a number as a percentage of 100.

E-

(Also "e-") Display a number in scientific format (exponential notation). If a format contains a zero (0) or a number (#) to the right of an exponent code, display the number in scientific format and inserts 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 (-) by negative exponents and a plus sign by positive exponents.

This method applies to the following interface:

IXTLRuntime.