Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

Convert.ToInt32 Method (String, IFormatProvider)

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

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

public:
static int ToInt32 (
	String^ value, 
	IFormatProvider^ provider
)
public static int ToInt32 (
	String value, 
	IFormatProvider provider
)
public static function ToInt32 (
	value : String, 
	provider : IFormatProvider
) : int
Not applicable.

Parameters

value

A String containing a number to convert.

provider

An IFormatProvider interface implementation that supplies culture-specific formatting information.

Return Value

A 32-bit signed integer equivalent to the value of value. -or- Zero if value is a null reference (Nothing in Visual Basic).
Exception typeCondition

FormatException

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

OverflowException

value represents a number less than MinValue or greater than 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 a null reference (Nothing in Visual Basic), the NumberFormatInfo for the current culture is used.

The following code example converts String representations of 32-bit integers with the ToInt32 method, using an IFormatProvider object.

// Example of the Convert::ToInt32( String* ) and 
// Convert::ToInt32( String*, IFormatProvider* ) methods.
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 = 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( gcnew String( protoFmt ), numericStr, defaultValue, providerValue );
}

int main()
{
   
   // Create a NumberFormatInfo object and set several of its
   // properties that apply to numbers.
   NumberFormatInfo^ provider = gcnew 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 = ",";
   array<Int32>^sizes = {3};
   provider->NumberGroupSizes = sizes;
   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( gcnew String( protoFmt ), "String to convert", "Default/exception", "Provider/exception" );
   Console::WriteLine( gcnew String( protoFmt ), "-----------------", "-----------------", "------------------" );
   
   // 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
*/

// Example of the Convert.ToInt32( string ) and 
// Convert.ToInt32( string, IFormatProvider ) methods.
import System.* ;
import System.Globalization.* ;

class ToInt32ProviderDemo
{
    private static String format = "{0,-20}{1,-20}{2}";   
   
    // Get the exception type name; remove the namespace prefix.
    static String GetExceptionType(System.Exception ex) 
    {
        String exceptionType = ex.GetType().ToString();
        return exceptionType.Substring((exceptionType.LastIndexOf('.') + 1)) ;
    } //GetExceptionType   
   
    static void ConvertToInt32(String numericStr, IFormatProvider provider) 
    {
        Object defaultValue;
        Object providerValue;
      
        // Convert numericStr to Int32 without a format provider.
        try {
            defaultValue = System.Convert.ToString(Convert.ToInt32(numericStr));
        }
        catch(System.Exception  ex) {      
            defaultValue = GetExceptionType(ex);
        }
      
        // Convert numericStr to Int32 with a format provider.
        try {
            providerValue = System.Convert.ToString(
                            Convert.ToInt32(numericStr, provider));
        }
        catch(System.Exception  ex) {      
            providerValue = GetExceptionType(ex);
        }
      
        Console.WriteLine(format, numericStr, defaultValue, providerValue);
     } //ConvertToInt32
      
    public static void main(String[] args)
    {
    
        // Create a NumberFormatInfo object and set several of its
        // properties that apply to numbers.
        NumberFormatInfo provider =  new NumberFormatInfo();
      
        // These properties affect the conversion.
        provider.set_NegativeSign("neg ");
        provider.set_PositiveSign("pos ");
      
        // These properties do not affect the conversion.
        // The input string cannot have decimal and group separators.
        provider.set_NumberDecimalSeparator(".");
        provider.set_NumberGroupSeparator(",");
        provider.set_NumberGroupSizes(new int[]{3});
        provider.set_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);
    } //main
} //ToInt32ProviderDemo

/*
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
*/

Windows 98, Windows Server 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 2.0, 1.0

XNA Framework

Supported in: 1.0
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.