Convert.ToInt32 Method (String, IFormatProvider)

 

Converts the specified string representation of a number to an equivalent 32-bit signed integer, using the specified culture-specific formatting information.

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

Public Shared Function ToInt32 (
	value As String,
	provider As IFormatProvider
) As Integer

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.Int32

A 32-bit signed integer that is equivalent to the number in value, or 0 (zero) if value is null.

Exception Condition
FormatException

value does not consist of an optional sign followed by a sequence of digits (0 through 9).

OverflowException

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

The return value is the result of invoking the Int32.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 null, the NumberFormatInfo for the current culture is used.

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

The following example defines a custom NumberFormatInfo object that recognizes the string "pos" as the positive sign and the string "neg" as the negative sign. It then attempts to convert each element of a numeric string array to an integer using both this provider and the NumberFormatInfo provider for the invariant culture.

Imports System.Globalization

Module Example
   Public Sub Main()
      ' Create a custom NumberFormatInfo object and set its two properties
      ' used by default in parsing numeric strings.
      Dim customProvider As New NumberFormatInfo()
      customProvider.NegativeSign = "neg "
      customProvider.PositiveSign = "pos "

      ' Add custom and invariant provider to an array of providers.
      Dim providers() As NumberFormatInfo = { customProvider, NumberFormatInfo.InvariantInfo }

      ' Define an array of strings to convert.
      Dim numericStrings() As String = { "123456789", "+123456789", "pos 123456789", _
                                         "-123456789", "neg 123456789", "123456789.", _
                                         "123,456,789", "(123456789)", "2147483648", _
                                         "-2147483649" } 

      ' Use each provider to parse all the numeric strings.
      For ctr As Integer = 0 To 1
         Dim provider As IFormatPRovider = providers(ctr)
         Console.WriteLine(IIf(ctr = 0, "Custom Provider:", "Invariant Provider:"))
         For Each numericString As String In numericStrings
            Console.Write("{0,15}  --> ", numericString)
            Try
               Console.WriteLine("{0,20}", Convert.ToInt32(numericString, provider))
            Catch e As FormatException
               Console.WriteLine("{0,20}", "FormatException") 
            Catch e As OverflowException
               Console.WriteLine("{0,20}", "OverflowException")                 
            End Try
         Next
         Console.WriteLine()
      Next                  
   End Sub 
End Module 
' The example displays the following output:
'       Custom Provider:
'             123456789  -->            123456789
'            +123456789  -->      FormatException
'         pos 123456789  -->            123456789
'            -123456789  -->      FormatException
'         neg 123456789  -->           -123456789
'            123456789.  -->      FormatException
'           123,456,789  -->      FormatException
'           (123456789)  -->      FormatException
'            2147483648  -->    OverflowException
'           -2147483649  -->      FormatException
'       
'       Invariant Provider:
'             123456789  -->            123456789
'            +123456789  -->            123456789
'         pos 123456789  -->      FormatException
'            -123456789  -->           -123456789
'         neg 123456789  -->      FormatException
'            123456789.  -->      FormatException
'           123,456,789  -->      FormatException
'           (123456789)  -->      FormatException
'            2147483648  -->    OverflowException
'           -2147483649  -->    OverflowException

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: