Export (0) Print
Expand All

Convert::ToDecimal Method (Object, IFormatProvider)

Converts the value of the specified object to an equivalent decimal number, using the specified culture-specific formatting information.

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

public:
static Decimal ToDecimal(
	Object^ value, 
	IFormatProvider^ provider
)

Parameters

value
Type: System::Object

An object that implements the IConvertible interface.

provider
Type: System::IFormatProvider

An object that supplies culture-specific formatting information.

Return Value

Type: System::Decimal
A decimal number that is equivalent to value, or 0 (zero) if value is nullptr.

ExceptionCondition
FormatException

value is not in an appropriate format for a Decimal type.

InvalidCastException

value does not implement the IConvertible interface.

-or-

The conversion is not supported.

OverflowException

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

The return value is the result of invoking the IConvertible::ToDecimal method of the underlying type of value.

provider enables the user to specify culture-specific conversion information about the contents of value. The base types ignore provider; however, the parameter may be used if value is a user-defined type that implements the IConvertible interface.

The following example defines a Temperature class that implements the IConvertible interface.

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

The following example shows that when a Temperature object is passed as a parameter to the ToDecimal(Object, IFormatProvider) method, the IConvertible::ToDecimal implementation of the Temperature class is called to perform the conversion.

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

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0, 2.0, 1.1

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

XNA Framework

Supported in: 3.0, 2.0, 1.0

Portable Class Library

Supported in: Portable Class Library

Supported in: Windows Phone 8.1

Supported in: Windows Phone Silverlight 8.1

Supported in: Windows Phone Silverlight 8
Show:
© 2015 Microsoft