Export (0) Print
Expand All

Convert.ToDecimal Method (Object)

Converts the value of the specified object to an equivalent decimal number.

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

'Declaration
Public Shared Function ToDecimal ( _
	value As Object _
) As Decimal
'Usage
Dim value As Object 
Dim returnValue As Decimal 

returnValue = Convert.ToDecimal(value)

Parameters

value
Type: System.Object

An object that implements the IConvertible interface, or Nothing.

Return Value

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

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.

The following example tries to convert each element in an object array to a Decimal value.

Dim values() As Object = { True, "a"c, 123, 1.764e32, "9.78", "1e-02", _
                           1.67e03, "A100", "1,033.67", Date.Now, _
                           Double.MaxValue }   
Dim result As Decimal

For Each value As Object In values
   Try
      result = Convert.ToDecimal(value)
      Console.WriteLine("Converted the {0} value {1} to {2}.", _
                        value.GetType().Name, value, result)
   Catch e As OverflowException
      Console.WriteLine("The {0} value {1} is out of range of the Decimal type.", _
                        value.GetType().Name, value)
   Catch e As FormatException
      Console.WriteLine("The {0} value {1} is not recognized as a valid Decimal value.", _
                        value.GetType().Name, value)
   Catch e As InvalidCastException
      Console.WriteLine("Conversion of the {0} value {1} to a Decimal is not supported.", _
                        value.GetType().Name, value)
   End Try                      
Next 
' The example displays the following output: 
'    Converted the Boolean value True to 1. 
'    Conversion of the Char value a to a Decimal is not supported. 
'    Converted the Int32 value 123 to 123. 
'    The Double value 1.764E+32 is out of range of the Decimal type. 
'    Converted the String value 9.78 to 9.78. 
'    The String value 1e-02 is not recognized as a valid Decimal value. 
'    Converted the Double value 1670 to 1670. 
'    The String value A100 is not recognized as a valid Decimal value. 
'    Converted the String value 1,033.67 to 1033.67. 
'    Conversion of the DateTime value 10/15/2008 05:40:42 PM to a Decimal is not supported. 
'    The Double value 1.79769313486232E+308 is out of range of the Decimal type.      

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98, Windows CE, Windows Mobile for Smartphone, Windows Mobile for Pocket PC, Xbox 360, Zune

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

.NET Framework

Supported in: 3.5, 3.0, 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 3.5, 2.0, 1.0

XNA Framework

Supported in: 3.0, 2.0, 1.0

Community Additions

ADD
Show:
© 2014 Microsoft