3 out of 9 rated this helpful - Rate this topic

Convert.ToInt32 Method

.NET Framework 1.1

Other Versions

Converts a specified value to a 32-bit signed integer.

Overload List

Converts the value of the specified Boolean value to the equivalent 32-bit signed integer.

Supported by the .NET Compact Framework.

[Visual Basic] Overloads Public Shared Function ToInt32(Boolean) As Integer

[C#] public static int ToInt32(bool);

[C++] public: static int ToInt32(bool);

[JScript] public static function ToInt32(Boolean) : int;

Converts the value of the specified 8-bit unsigned integer to the equivalent 32-bit signed integer.

Supported by the .NET Compact Framework.

[Visual Basic] Overloads Public Shared Function ToInt32(Byte) As Integer

[C#] public static int ToInt32(byte);

[C++] public: static int ToInt32(unsigned char);

[JScript] public static function ToInt32(Byte) : int;

Converts the value of the specified Unicode character to the equivalent 32-bit signed integer.

Supported by the .NET Compact Framework.

[Visual Basic] Overloads Public Shared Function ToInt32(Char) As Integer

[C#] public static int ToInt32(char);

[C++] public: static int ToInt32(__wchar_t);

[JScript] public static function ToInt32(Char) : int;

Calling this method always throws InvalidCastException.

[Visual Basic] Overloads Public Shared Function ToInt32(DateTime) As Integer

[C#] public static int ToInt32(DateTime);

[C++] public: static int ToInt32(DateTime);

[JScript] public static function ToInt32(DateTime) : int;

Converts the value of the specified Decimal number to an equivalent 32-bit signed integer.

Supported by the .NET Compact Framework.

[Visual Basic] Overloads Public Shared Function ToInt32(Decimal) As Integer

[C#] public static int ToInt32(decimal);

[C++] public: static int ToInt32(Decimal);

[JScript] public static function ToInt32(Decimal) : int;

Converts the value of the specified double-precision floating point number to an equivalent 32-bit signed integer.

Supported by the .NET Compact Framework.

[Visual Basic] Overloads Public Shared Function ToInt32(Double) As Integer

[C#] public static int ToInt32(double);

[C++] public: static int ToInt32(double);

[JScript] public static function ToInt32(double) : int;

Converts the value of the specified 16-bit signed integer to an equivalent 32-bit signed integer.

Supported by the .NET Compact Framework.

[Visual Basic] Overloads Public Shared Function ToInt32(Short) As Integer

[C#] public static int ToInt32(short);

[C++] public: static int ToInt32(short);

[JScript] public static function ToInt32(Int16) : int;

Returns the specified 32-bit signed integer; no actual conversion is performed.

Supported by the .NET Compact Framework.

[Visual Basic] Overloads Public Shared Function ToInt32(Integer) As Integer

[C#] public static int ToInt32(int);

[C++] public: static int ToInt32(int);

[JScript] public static function ToInt32(int) : int;

Converts the value of the specified 64-bit signed integer to an equivalent 32-bit signed integer.

Supported by the .NET Compact Framework.

[Visual Basic] Overloads Public Shared Function ToInt32(Long) As Integer

[C#] public static int ToInt32(long);

[C++] public: static int ToInt32(__int64);

[JScript] public static function ToInt32(long) : int;

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

Supported by the .NET Compact Framework.

[Visual Basic] Overloads Public Shared Function ToInt32(Object) As Integer

[C#] public static int ToInt32(object);

[C++] public: static int ToInt32(Object*);

[JScript] public static function ToInt32(Object) : int;

Converts the value of the specified 8-bit signed integer to the equivalent 32-bit signed integer. This method is not CLS-compliant.

Supported by the .NET Compact Framework.

[Visual Basic] Overloads Public Shared Function ToInt32(SByte) As Integer

[C#] public static int ToInt32(sbyte);

[C++] public: static int ToInt32(char);

[JScript] public static function ToInt32(SByte) : int;

Converts the value of the specified single-precision floating point number to an equivalent 32-bit signed integer.

Supported by the .NET Compact Framework.

[Visual Basic] Overloads Public Shared Function ToInt32(Single) As Integer

[C#] public static int ToInt32(float);

[C++] public: static int ToInt32(float);

[JScript] public static function ToInt32(float) : int;

Converts the specified String representation of a number to an equivalent 32-bit signed integer.

Supported by the .NET Compact Framework.

[Visual Basic] Overloads Public Shared Function ToInt32(String) As Integer

[C#] public static int ToInt32(string);

[C++] public: static int ToInt32(String*);

[JScript] public static function ToInt32(String) : int;

Converts the value of the specified 16-bit unsigned integer to the equivalent 32-bit signed integer. This method is not CLS-compliant.

Supported by the .NET Compact Framework.

[Visual Basic] Overloads Public Shared Function ToInt32(UInt16) As Integer

[C#] public static int ToInt32(ushort);

[C++] public: static int ToInt32(unsigned short);

[JScript] public static function ToInt32(UInt16) : int;

Converts the value of the specified 32-bit unsigned integer to an equivalent 32-bit signed integer. This method is not CLS-compliant.

Supported by the .NET Compact Framework.

[Visual Basic] Overloads Public Shared Function ToInt32(UInt32) As Integer

[C#] public static int ToInt32(uint);

[C++] public: static int ToInt32(unsigned int);

[JScript] public static function ToInt32(UInt32) : int;

Converts the value of the specified 64-bit unsigned integer to an equivalent 32-bit signed integer. This method is not CLS-compliant.

Supported by the .NET Compact Framework.

[Visual Basic] Overloads Public Shared Function ToInt32(UInt64) As Integer

[C#] public static int ToInt32(ulong);

[C++] public: static int ToInt32(unsigned __int64);

[JScript] public static function ToInt32(UInt64) : int;

Converts the value of the specified Object to a 32-bit signed integer using the specified culture-specific formatting information.

[Visual Basic] Overloads Public Shared Function ToInt32(Object, IFormatProvider) As Integer

[C#] public static int ToInt32(object, IFormatProvider);

[C++] public: static int ToInt32(Object*, IFormatProvider*);

[JScript] public static function ToInt32(Object, IFormatProvider) : int;

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

Supported by the .NET Compact Framework.

[Visual Basic] Overloads Public Shared Function ToInt32(String, IFormatProvider) As Integer

[C#] public static int ToInt32(string, IFormatProvider);

[C++] public: static int ToInt32(String*, IFormatProvider*);

[JScript] public static function ToInt32(String, IFormatProvider) : int;

Converts the String representation of a number in a specified base to an equivalent 32-bit signed integer.

Supported by the .NET Compact Framework.

[Visual Basic] Overloads Public Shared Function ToInt32(String, Integer) As Integer

[C#] public static int ToInt32(string, int);

[C++] public: static int ToInt32(String*, int);

[JScript] public static function ToInt32(String, int) : int;

Example

[Visual Basic, C#, C++] The following code example converts String representations of Int32 (32-bit integers) with the ToInt32 method, using an IFormatProvider object.

[Visual Basic, C#, C++] Note This example shows how to use one of the overloaded versions of ToInt32. For other examples that might be available, see the individual overload topics.

[Visual Basic] 
' Example of the Convert.ToInt32( String ) and 
' Convert.ToInt32( String, IFormatProvider ) methods.
Imports System
Imports System.Globalization
Imports Microsoft.VisualBasic

Module ToInt32ProviderDemo

    Dim format As String = "{0,-20}{1,-20}{2}"

    ' Get the exception type name; remove the namespace prefix.
    Function GetExceptionType( ex As Exception ) As String

        Dim exceptionType   As String = ex.GetType( ).ToString( )
        Return exceptionType.Substring( _
            exceptionType.LastIndexOf( "."c ) + 1 )
    End Function

    Sub ConvertToInt32( numericStr As String, _
        provider As IFormatProvider )

        Dim defaultValue    As Object
        Dim providerValue   As Object

        ' Convert numericStr to Int32 without a format provider.
        Try
            defaultValue = Convert.ToInt32( numericStr )
        Catch ex As Exception
            defaultValue = GetExceptionType( ex )
        End Try

        ' Convert numericStr to Int32 with a format provider.
        Try
            providerValue = Convert.ToInt32( numericStr, provider )
        Catch ex As Exception
            providerValue = GetExceptionType( ex )
        End Try

        Console.WriteLine( format, numericStr, _
            defaultValue, providerValue )
    End Sub

    Sub Main( )

        ' Create a NumberFormatInfo object and set several of its
        ' properties that apply to numbers.
        Dim provider  As NumberFormatInfo = new NumberFormatInfo( )

        ' These properties affect the conversion.
        provider.NegativeSign = "neg "
        provider.PositiveSign = "pos "

        ' These properties do not affect the conversion.
        ' The input string cannot have decimal and group separators.
        provider.NumberDecimalSeparator = "."
        provider.NumberGroupSeparator = ","
        provider.NumberGroupSizes = New Integer( ) { 3 }
        provider.NumberNegativePattern = 0

        Console.WriteLine( "This example of" & vbCrLf & _
            "  Convert.ToInt32( String ) and " & vbCrLf & _
            "  Convert.ToInt32( String, IFormatProvider ) " & _
            vbCrLf & "generates the following output. It " & _
            "converts several strings to " & vbCrLf & "Integer " & _
            "values, using default formatting " & _
            "or a NumberFormatInfo object." & vbCrLf )
        Console.WriteLine( format, "String to convert", _
            "Default/exception", "Provider/exception" )
        Console.WriteLine( format, "-----------------", _
            "-----------------", "------------------" )

        ' Convert strings, with and without an IFormatProvider.
        ConvertToInt32( "123456789", provider )
        ConvertToInt32( "+123456789", provider )
        ConvertToInt32( "pos 123456789", provider )
        ConvertToInt32( "-123456789", provider )
        ConvertToInt32( "neg 123456789", provider )
        ConvertToInt32( "123456789.", provider )
        ConvertToInt32( "123,456,789", provider )
        ConvertToInt32( "(123456789)", provider )
        ConvertToInt32( "2147483648", provider )
        ConvertToInt32( "-2147483649", provider )
    End Sub 
End Module 

' This example of
'   Convert.ToInt32( String ) and
'   Convert.ToInt32( String, IFormatProvider )
' generates the following output. It converts several strings to
' Integer values, using default formatting or a NumberFormatInfo object.
' 
' String to convert   Default/exception   Provider/exception
' -----------------   -----------------   ------------------
' 123456789           123456789           123456789
' +123456789          123456789           FormatException
' pos 123456789       FormatException     123456789
' -123456789          -123456789          FormatException
' neg 123456789       FormatException     -123456789
' 123456789.          FormatException     FormatException
' 123,456,789         FormatException     FormatException
' (123456789)         FormatException     FormatException
' 2147483648          OverflowException   OverflowException
' -2147483649         OverflowException   FormatException

[C#] 
// Example of the Convert.ToInt32( string ) and 
// Convert.ToInt32( string, IFormatProvider ) methods.
using System;
using System.Globalization;

class ToInt32ProviderDemo
{
    static string format = "{0,-20}{1,-20}{2}";

     // Get the exception type name; remove the namespace prefix.
    static string GetExceptionType( Exception ex )
    {
        string exceptionType = ex.GetType( ).ToString( );
        return exceptionType.Substring( 
            exceptionType.LastIndexOf( '.' ) + 1 );
    }

    static void ConvertToInt32( string numericStr, 
        IFormatProvider provider )
    {
        object defaultValue;
        object providerValue;

        // Convert numericStr to Int32 without a format provider.
        try
        {
            defaultValue = Convert.ToInt32( numericStr );
        }
        catch( Exception ex )
        {
            defaultValue = GetExceptionType( ex );
        }

        // Convert numericStr to Int32 with a format provider.
        try
        {
            providerValue = Convert.ToInt32( numericStr, provider );
        }
        catch( Exception ex )
        {
            providerValue = GetExceptionType( ex );
        }

        Console.WriteLine( format, numericStr, 
            defaultValue, providerValue );
    }

    public static void Main( )
    {
        // Create a NumberFormatInfo object and set several of its
        // properties that apply to numbers.
        NumberFormatInfo provider = new NumberFormatInfo();

        // These properties affect the conversion.
        provider.NegativeSign = "neg ";
        provider.PositiveSign = "pos ";

        // These properties do not affect the conversion.
        // The input string cannot have decimal and group separators.
        provider.NumberDecimalSeparator = ".";
        provider.NumberGroupSeparator = ",";
        provider.NumberGroupSizes = new int[ ] { 3 };
        provider.NumberNegativePattern = 0;

        Console.WriteLine("This example of\n" +
            "  Convert.ToInt32( string ) and \n" +
            "  Convert.ToInt32( string, IFormatProvider ) " +
            "\ngenerates the following output. It converts " +
            "several strings to \nint values, using " +
            "default formatting or a NumberFormatInfo object.\n" );
        Console.WriteLine( format, "String to convert", 
            "Default/exception", "Provider/exception" );
        Console.WriteLine( format, "-----------------", 
            "-----------------", "------------------" );

        // Convert strings, with and without an IFormatProvider.
        ConvertToInt32( "123456789", provider );
        ConvertToInt32( "+123456789", provider );
        ConvertToInt32( "pos 123456789", provider );
        ConvertToInt32( "-123456789", provider );
        ConvertToInt32( "neg 123456789", provider );
        ConvertToInt32( "123456789.", provider );
        ConvertToInt32( "123,456,789", provider );
        ConvertToInt32( "(123456789)", provider );
        ConvertToInt32( "2147483648", provider );
        ConvertToInt32( "-2147483649", provider );
    }
}

/*
This example of
  Convert.ToInt32( string ) and
  Convert.ToInt32( string, IFormatProvider )
generates the following output. It converts several strings to
int values, using default formatting or a NumberFormatInfo object.

String to convert   Default/exception   Provider/exception
-----------------   -----------------   ------------------
123456789           123456789           123456789
+123456789          123456789           FormatException
pos 123456789       FormatException     123456789
-123456789          -123456789          FormatException
neg 123456789       FormatException     -123456789
123456789.          FormatException     FormatException
123,456,789         FormatException     FormatException
(123456789)         FormatException     FormatException
2147483648          OverflowException   OverflowException
-2147483649         OverflowException   FormatException
*/ 

[C++] 
// Example of the Convert::ToInt32( String* ) and 
// Convert::ToInt32( String*, IFormatProvider* ) methods.
#using <mscorlib.dll>
using namespace System;
using namespace System::Globalization;

const __wchar_t* protoFmt = L"{0,-20}{1,-20}{2}" ;

// Get the exception type name; remove the namespace prefix.
String* GetExceptionType( Exception* ex )
{
    String* exceptionType = ex->GetType( )->ToString( );
    return exceptionType->Substring( 
        exceptionType->LastIndexOf( '.' ) + 1 );
}

void ConvertToInt32( String* numericStr, IFormatProvider* provider )
{
    Object* defaultValue;
    Object* providerValue;

    // Convert numericStr to Int32 without a format provider.
    try
    {
        defaultValue = __box( Convert::ToInt32( numericStr ) );
    }
    catch( Exception* ex )
    {
        defaultValue = GetExceptionType( ex );
    }

    // Convert numericStr to Int32 with a format provider.
    try
    {
        providerValue = __box( Convert::ToInt32( 
            numericStr, provider ) );
    }
    catch( Exception* ex )
    {
        providerValue = GetExceptionType( ex );
    }

    Console::WriteLine( new String( protoFmt ), numericStr, 
        defaultValue, providerValue );
}

void main( )
{
    // Create a NumberFormatInfo object and set several of its
    // properties that apply to numbers.
    NumberFormatInfo* provider = new NumberFormatInfo( );

    // These properties affect the conversion.
    provider->NegativeSign = S"neg ";
    provider->PositiveSign = S"pos ";

    // These properties do not affect the conversion.
    // The input string cannot have decimal and group separators.
    provider->NumberDecimalSeparator = S".";
    provider->NumberGroupSeparator = S",";
    Int32 sizes __gc [ ] = { 3 };
    provider->NumberGroupSizes = sizes;
    provider->NumberNegativePattern = 0;

    Console::WriteLine(S"This example of\n" 
        S"  Convert::ToInt32( String* ) and \n" 
        S"  Convert::ToInt32( String*, IFormatProvider* ) " 
        S"\ngenerates the following output. It converts " 
        S"several strings to \nint values, using " 
        S"default formatting or a NumberFormatInfo object.\n" );
    Console::WriteLine( new String( protoFmt ), S"String to convert", 
        S"Default/exception", S"Provider/exception" );
    Console::WriteLine( new String( protoFmt ), S"-----------------", 
        S"-----------------", S"------------------" );

    // Convert strings, with and without an IFormatProvider.
    ConvertToInt32( S"123456789", provider );
    ConvertToInt32( S"+123456789", provider );
    ConvertToInt32( S"pos 123456789", provider );
    ConvertToInt32( S"-123456789", provider );
    ConvertToInt32( S"neg 123456789", provider );
    ConvertToInt32( S"123456789.", provider );
    ConvertToInt32( S"123,456,789", provider );
    ConvertToInt32( S"(123456789)", provider );
    ConvertToInt32( S"2147483648", provider );
    ConvertToInt32( S"-2147483649", provider );
}

/*
This example of
  Convert::ToInt32( String* ) and
  Convert::ToInt32( String*, IFormatProvider* )
generates the following output. It converts several strings to
int values, using default formatting or a NumberFormatInfo object.

String to convert   Default/exception   Provider/exception
-----------------   -----------------   ------------------
123456789           123456789           123456789
+123456789          123456789           FormatException
pos 123456789       FormatException     123456789
-123456789          -123456789          FormatException
neg 123456789       FormatException     -123456789
123456789.          FormatException     FormatException
123,456,789         FormatException     FormatException
(123456789)         FormatException     FormatException
2147483648          OverflowException   OverflowException
-2147483649         OverflowException   FormatException
*/

[JScript] No example is available for JScript. To view a Visual Basic, C#, or C++ example, click the Language Filter button in the upper-left corner of the page.

Convert.ToInt32 Method

Overload List

Example

See Also