Convert.ToInt16 Method (String)
Converts the specified string representation of a number to an equivalent 16-bit signed integer.
Assembly: mscorlib (in mscorlib.dll)
Parameters
- value
-
Type:
System.String
A string that contains the number to convert.
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. |
Using the ToInt16(String) method is equivalent to passing value to the Int16.Parse(String) method. value is interpreted by using the formatting conventions of the current thread culture.
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 default formatting.
' Example of the Convert.ToInt16( String ) and ' Convert.ToInt16( String, IFormatProvider ) methods. Imports System Imports System.Globalization Imports Microsoft.VisualBasic Module ToInt16ProviderDemo 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 ConvertToInt16( numericStr As String, _ provider As IFormatProvider ) Dim defaultValue As Object Dim providerValue As Object ' Convert numericStr to Int16 without a format provider. Try defaultValue = Convert.ToInt16( numericStr ) Catch ex As Exception defaultValue = GetExceptionType( ex ) End Try ' Convert numericStr to Int16 with a format provider. Try providerValue = Convert.ToInt16( 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.ToInt16( String ) and " & vbCrLf & _ " Convert.ToInt16( String, IFormatProvider ) " & _ vbCrLf & "generates the following output. It " & _ "converts several strings to " & vbCrLf & "Short " & _ "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. 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 ) End Sub End Module ' 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