Convert.ToInt32 Method (Object)

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Converts the value of the specified object to a 32-bit signed integer.

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

Public Shared Function ToInt32 (
	value As Object
) As Integer

Parameters

value
Type: System.Object

An object that implements the IConvertible interface, or null.

Return Value

Type: System.Int32

A 32-bit signed integer equivalent to value, or zero if value is null.

Exception Condition
FormatException

value is not in an appropriate format.

InvalidCastException

value does not implement the IConvertible interface.

-or-

The conversion is not supported.

OverflowException

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

Ifvalue is not null, this method wraps a call to the IConvertible.ToInt32implementation of the underlying type of value.

The following example attempts to convert each element in an object array to an integer.

Dim values() As Object = { True, -12, 163, 935, "x"c, #5/12/2009#, _
                           "104", "103.0", "-1", _
                           "1.00e2", "One", 1.00e2, 16.3e42}
Dim result As Integer

For Each value As Object In values
   Try
      result = Convert.ToInt32(value)
      Console.WriteLine("Converted the {0} value {1} to the {2} value {3}.", _
                        value.GetType().Name, value, _
                        result.GetType().Name, result)
   Catch e As OverflowException
      Console.WriteLine("The {0} value {1} is outside the range of the Int32 type.", _
                        value.GetType().Name, value)
   Catch e As FormatException
      Console.WriteLine("The {0} value {1} is not in a recognizable format.", _
                        value.GetType().Name, value)
   Catch e As InvalidCastException
      Console.WriteLine("No conversion to an Int32 exists for the {0} value {1}.", _
                        value.GetType().Name, value)

   End Try
Next                           
' The example displays the following output:
'    Converted the Boolean value True to the Int32 value 1.
'    Converted the Int32 value -12 to the Int32 value -12.
'    Converted the Int32 value 163 to the Int32 value 163.
'    Converted the Int32 value 935 to the Int32 value 935.
'    Converted the Char value x to the Int32 value 120.
'    No conversion to an Int32 exists for the DateTime value 5/12/2009 12:00:00 AM.
'    Converted the String value 104 to the Int32 value 104.
'    The String value 103.0 is not in a recognizable format.
'    Converted the String value -1 to the Int32 value -1.
'    The String value 1.00e2 is not in a recognizable format.
'    The String value One is not in a recognizable format.
'    Converted the Double value 100 to the Int32 value 100.
'    The Double value 1.63E+43 is outside the range of the Int32 type.

Universal Windows Platform
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
Return to top
Show: