Convert::ToDecimal Method (Object^, IFormatProvider^)
Converts the value of the specified object to an equivalent decimal number, using the specified culture-specific formatting information.
Assembly: mscorlib (in mscorlib.dll)
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::DecimalA decimal number that is equivalent to value, or 0 (zero) if value is null.
| Exception | Condition |
|---|---|
| FormatException | value is not in an appropriate format for a Decimal type. |
| InvalidCastException | |
| 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.
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.
Available since 8
.NET Framework
Available since 1.1
Portable Class Library
Supported in: portable .NET platforms
Silverlight
Available since 2.0
Windows Phone Silverlight
Available since 7.0
Windows Phone
Available since 8.1