Convert.ToInt16 Method (String, IFormatProvider)
Converts the specified string representation of a number to an equivalent 16-bit signed integer, using the specified culture-specific formatting information.
Assembly: mscorlib (in mscorlib.dll)
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.Int16A 16-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 Int16.MinValue or greater than Int16.MaxValue. |
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 Int16.TryParse method instead. It returns a Boolean value that indicates whether the conversion succeeded or failed.
The following example converts string representations of 16-bit integers with the ToInt16 method, using an IFormatProvider object.
// Example of the Convert.ToInt16( string ) and // Convert.ToInt16( string, IFormatProvider ) methods. using System; using System.Globalization; class ToInt16ProviderDemo { 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 ConvertToInt16( string numericStr, IFormatProvider provider ) { object defaultValue; object providerValue; // Convert numericStr to Int16 without a format provider. try { defaultValue = Convert.ToInt16( numericStr ); } catch( Exception ex ) { defaultValue = GetExceptionType( ex ); } // Convert numericStr to Int16 with a format provider. try { providerValue = Convert.ToInt16( 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.ToInt16( string ) and \n" + " Convert.ToInt16( string, IFormatProvider ) " + "\ngenerates the following output. It converts " + "several strings to \nshort 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. ConvertToInt16( "12345", provider ); ConvertToInt16( "+12345", provider ); ConvertToInt16( "pos 12345", provider ); ConvertToInt16( "-12345", provider ); ConvertToInt16( "neg 12345", provider ); ConvertToInt16( "12345.", provider ); ConvertToInt16( "12,345", provider ); ConvertToInt16( "(12345)", provider ); ConvertToInt16( "32768", provider ); ConvertToInt16( "-32769", provider ); } } /* This example of Convert.ToInt16( string ) and Convert.ToInt16( string, IFormatProvider ) generates the following output. It converts several strings to short values, using default formatting or a NumberFormatInfo object. String to convert Default/exception Provider/exception ----------------- ----------------- ------------------ 12345 12345 12345 +12345 12345 FormatException pos 12345 FormatException 12345 -12345 -12345 FormatException neg 12345 FormatException -12345 12345. FormatException FormatException 12,345 FormatException FormatException (12345) FormatException FormatException 32768 OverflowException OverflowException -32769 OverflowException FormatException */
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