This documentation is archived and is not being maintained.

Convert::ToDouble Method (String, IFormatProvider)

Converts the specified string representation of a number to an equivalent double-precision floating-point number, using the specified culture-specific formatting information.

Namespace:  System
Assembly:  mscorlib (in mscorlib.dll)

public:
static double ToDouble(
	String^ value, 
	IFormatProvider^ provider
)

Parameters

value
Type: System::String
A string that contains the number to convert.
provider
Type: System::IFormatProvider
An object that supplies culture-specific formatting information.

Return Value

Type: System::Double
A double-precision floating-point number that is equivalent to the number in value, or 0 (zero) if value is nullptr.

ExceptionCondition
FormatException

value is not a number in a valid format.

OverflowException

value represents a number that is less than Double::MinValue or greater than Double::MaxValue.

The return value is the result of invoking the Double::Parse method on value.

provider is an IFormatProvider instance that obtains a NumberFormatInfo object. The NumberFormatInfo object provides culture-specific information about the format of value. If provider is nullptr, the NumberFormatInfo for the current culture is used.

If you prefer not to handle an exception if the conversion fails, you can call the Double::TryParse method instead. It returns a Boolean value that indicates whether the conversion succeeded or failed.

The following example converts string representations of Double values with the ToDouble method, using an IFormatProvider object.

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

.NET Framework

Supported in: 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

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

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