This topic has not yet been rated - Rate this topic

Double::Parse Method (String, NumberStyles, IFormatProvider)

Converts the string representation of a number in a specified style and culture-specific format to its double-precision floating-point number equivalent.

Namespace:  System
Assembly:  mscorlib (in mscorlib.dll)
public:
static double Parse(
	String^ s, 
	NumberStyles style, 
	IFormatProvider^ provider
)

Parameters

s
Type: System::String

A string that contains a number to convert.

style
Type: System.Globalization::NumberStyles

A bitwise combination of enumeration values that indicate the style elements that can be present in s. A typical value to specify is Float combined with AllowThousands.

provider
Type: System::IFormatProvider

An object that supplies culture-specific formatting information about s.

Return Value

Type: System::Double
A double-precision floating-point number that is equivalent to the numeric value or symbol specified in s.
ExceptionCondition
ArgumentNullException

s is nullptr.

FormatException

s does not represent a numeric value.

ArgumentException

style is not a NumberStyles value.

-or-

style is the NumberStyles::AllowHexSpecifier value.

OverflowException

s represents a number that is less than MinValue or greater than MaxValue.

The style parameter defines the style elements (such as white space, thousands separators, and currency symbols) that are allowed in the s parameter for the parse operation to succeed. It must be a combination of bit flags from the NumberStyles enumeration. The following NumberStyles members are not supported:

The s parameter can contain NumberFormatInfo::PositiveInfinitySymbol, NumberFormatInfo::NegativeInfinitySymbol, or NumberFormatInfo::NaNSymbol for the culture specified by provider. Depending on the value of style, it can also take the form:

[ws] [$] [sign][integral-digits,]integral-digits[.[fractional-digits]][E[sign]exponential-digits][ws]

Elements framed in square brackets ([ and ]) are optional. The following table describes each element.

Element

Description

ws

A series of white-space characters. White space can appear at the beginning of s if style includes the NumberStyles::AllowLeadingWhite flag, and it can appear at the end of s if style includes the NumberStyles::AllowTrailingWhite flag.

$

A culture-specific currency symbol. Its position in the string is defined by the NumberFormatInfo::CurrencyNegativePattern and NumberFormatInfo::CurrencyPositivePattern properties of the current culture. The current culture's currency symbol can appear in s if style includes the NumberStyles::AllowCurrencySymbol flag.

sign

A negative sign symbol (-) or a positive sign symbol (+). The sign can appear at the beginning of s if style includes the NumberStyles::AllowLeadingSign flag, and it can appear at the end of s if style includes the NumberStyles::AllowTrailingSign flag. Parentheses can be used in s to indicate a negative value if style includes the NumberStyles::AllowParentheses flag.

integral-digits

A series of digits ranging from 0 to 9 that specify the integral part of the number. The integral-digits element can be absent if the string contains the fractional-digits element.

,

A culture-specific group separator. The current culture's group separator symbol can appear in s if style includes the NumberStyles::AllowThousands flag

.

A culture-specific decimal point symbol. The current culture's decimal point symbol can appear in s if style includes the NumberStyles::AllowDecimalPoint flag.

fractional-digits

A series of digits ranging from 0 to 9 that specify the fractional part of the number. Fractional digits can appear in s if style includes the NumberStyles::AllowDecimalPoint flag.

E

The "e" or "E" character, which indicates that the value is represented in exponential (scientific) notation. The s parameter can represent a number in exponential notation if style includes the NumberStyles::AllowExponent flag.

exponential-digits

A series of digits ranging from 0 to 9 that specify an exponent.

A string with digits only (which corresponds to the NumberStyles::None style) always parses successfully. The remaining System.Globalization::NumberStyles members control elements that may be present, but are not required to be present, in the input string. The following table indicates how individual NumberStyles flags affect the elements that may be present in s.

NumberStyles value

Elements permitted in s in addition to digits

None

The integral-digits element only.

AllowDecimalPoint

The decimal point (.) and fractional-digits elements.

AllowExponent

The "e" or "E" character, which indicates exponential notation. This flag by itself supports values in the form digitsEdigits; additional flags are needed to successfully parse strings with such elements as positive or negative signs and decimal point symbols.

AllowLeadingWhite

The ws element at the beginning of s.

AllowTrailingWhite

The ws element at the end of s.

AllowLeadingSign

The sign element at the beginning of s.

AllowTrailingSign

The sign element at the end of s.

AllowParentheses

The sign element in the form of parentheses enclosing the numeric value.

AllowThousands

The thousands separator (,) element.

AllowCurrencySymbol

The currency ($) element.

Currency

All elements. However, s cannot represent a hexadecimal number or a number in exponential notation.

Float

The ws element at the beginning or end of s, sign at the beginning of s, and the decimal point (.) symbol. The s parameter can also use exponential notation.

Number

The ws, sign, thousands separator (,) and decimal point (.) elements.

Any

All elements. However, s cannot represent a hexadecimal number.

The provider parameter is an IFormatProvider implementation whose GetFormat method returns a NumberFormatInfo object that supplies culture-specific information used in interpreting the format of s. Typically, it is a NumberFormatInfo or CultureInfo object. If provider is nullptr or a NumberFormatInfo cannot be obtained, the formatting information for the current system culture is used.

Ordinarily, if you pass the Double::Parse method a string that is created by calling the Double::ToString method, the original Double value is returned. However, because of a loss of precision, the values may not be equal. In addition, attempting to parse the string representation of either MinValue or MaxValue throws an OverflowException, as the following example illustrates.

No code example is currently available or this language may not be supported.

If a separator is encountered in the s parameter during a parse operation, and the applicable currency or number decimal and group separators are the same, the parse operation assumes that the separator is a decimal separator rather than a group separator. For more information about separators, see CurrencyDecimalSeparator, NumberDecimalSeparator, CurrencyGroupSeparator, and NumberGroupSeparator.

The following example illustrates the use of the Parse(String, NumberStyles, IFormatProvider) method to assign several string representations of temperature values to a Temperature object.

No code example is currently available or this language may not be supported.

.NET Framework

Supported in: 4.5.1, 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Portable Class Library

Supported in: Portable Class Library

.NET for Windows Store apps

Supported in: Windows 8

.NET for Windows Phone apps

Supported in: Windows Phone 8.1, Windows Phone 8, Silverlight 8.1

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.