Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

Convert.ToInt16 Method

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

Overload List

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

Supported by the .NET Compact Framework.

[Visual Basic] Overloads Public Shared Function ToInt16(Boolean) As Short
[C#] public static short ToInt16(bool);
[C++] public: static short ToInt16(bool);
[JScript] public static function ToInt16(Boolean) : Int16;

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

Supported by the .NET Compact Framework.

[Visual Basic] Overloads Public Shared Function ToInt16(Byte) As Short
[C#] public static short ToInt16(byte);
[C++] public: static short ToInt16(unsigned char);
[JScript] public static function ToInt16(Byte) : Int16;

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

Supported by the .NET Compact Framework.

[Visual Basic] Overloads Public Shared Function ToInt16(Char) As Short
[C#] public static short ToInt16(char);
[C++] public: static short ToInt16(__wchar_t);
[JScript] public static function ToInt16(Char) : Int16;

Calling this method always throws InvalidCastException.

[Visual Basic] Overloads Public Shared Function ToInt16(DateTime) As Short
[C#] public static short ToInt16(DateTime);
[C++] public: static short ToInt16(DateTime);
[JScript] public static function ToInt16(DateTime) : Int16;

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

Supported by the .NET Compact Framework.

[Visual Basic] Overloads Public Shared Function ToInt16(Decimal) As Short
[C#] public static short ToInt16(decimal);
[C++] public: static short ToInt16(Decimal);
[JScript] public static function ToInt16(Decimal) : Int16;

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

Supported by the .NET Compact Framework.

[Visual Basic] Overloads Public Shared Function ToInt16(Double) As Short
[C#] public static short ToInt16(double);
[C++] public: static short ToInt16(double);
[JScript] public static function ToInt16(double) : Int16;

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

Supported by the .NET Compact Framework.

[Visual Basic] Overloads Public Shared Function ToInt16(Short) As Short
[C#] public static short ToInt16(short);
[C++] public: static short ToInt16(short);
[JScript] public static function ToInt16(Int16) : Int16;

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

Supported by the .NET Compact Framework.

[Visual Basic] Overloads Public Shared Function ToInt16(Integer) As Short
[C#] public static short ToInt16(int);
[C++] public: static short ToInt16(int);
[JScript] public static function ToInt16(int) : Int16;

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

Supported by the .NET Compact Framework.

[Visual Basic] Overloads Public Shared Function ToInt16(Long) As Short
[C#] public static short ToInt16(long);
[C++] public: static short ToInt16(__int64);
[JScript] public static function ToInt16(long) : Int16;

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

[Visual Basic] Overloads Public Shared Function ToInt16(Object) As Short
[C#] public static short ToInt16(object);
[C++] public: static short ToInt16(Object*);
[JScript] public static function ToInt16(Object) : Int16;

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

Supported by the .NET Compact Framework.

[Visual Basic] Overloads Public Shared Function ToInt16(SByte) As Short
[C#] public static short ToInt16(sbyte);
[C++] public: static short ToInt16(char);
[JScript] public static function ToInt16(SByte) : Int16;

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

Supported by the .NET Compact Framework.

[Visual Basic] Overloads Public Shared Function ToInt16(Single) As Short
[C#] public static short ToInt16(float);
[C++] public: static short ToInt16(float);
[JScript] public static function ToInt16(float) : Int16;

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

Supported by the .NET Compact Framework.

[Visual Basic] Overloads Public Shared Function ToInt16(String) As Short
[C#] public static short ToInt16(string);
[C++] public: static short ToInt16(String*);
[JScript] public static function ToInt16(String) : Int16;

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

Supported by the .NET Compact Framework.

[Visual Basic] Overloads Public Shared Function ToInt16(UInt16) As Short
[C#] public static short ToInt16(ushort);
[C++] public: static short ToInt16(unsigned short);
[JScript] public static function ToInt16(UInt16) : Int16;

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

Supported by the .NET Compact Framework.

[Visual Basic] Overloads Public Shared Function ToInt16(UInt32) As Short
[C#] public static short ToInt16(uint);
[C++] public: static short ToInt16(unsigned int);
[JScript] public static function ToInt16(UInt32) : Int16;

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

Supported by the .NET Compact Framework.

[Visual Basic] Overloads Public Shared Function ToInt16(UInt64) As Short
[C#] public static short ToInt16(ulong);
[C++] public: static short ToInt16(unsigned __int64);
[JScript] public static function ToInt16(UInt64) : Int16;

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

Supported by the .NET Compact Framework.

[Visual Basic] Overloads Public Shared Function ToInt16(Object, IFormatProvider) As Short
[C#] public static short ToInt16(object, IFormatProvider);
[C++] public: static short ToInt16(Object*, IFormatProvider*);
[JScript] public static function ToInt16(Object, IFormatProvider) : Int16;

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

Supported by the .NET Compact Framework.

[Visual Basic] Overloads Public Shared Function ToInt16(String, IFormatProvider) As Short
[C#] public static short ToInt16(string, IFormatProvider);
[C++] public: static short ToInt16(String*, IFormatProvider*);
[JScript] public static function ToInt16(String, IFormatProvider) : Int16;

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

Supported by the .NET Compact Framework.

[Visual Basic] Overloads Public Shared Function ToInt16(String, Integer) As Short
[C#] public static short ToInt16(string, int);
[C++] public: static short ToInt16(String*, int);
[JScript] public static function ToInt16(String, int) : Int16;

Example

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

[Visual Basic, C#, C++] Note   This example shows how to use one of the overloaded versions of ToInt16. For other examples that might be available, see the individual overload topics.
[Visual Basic] 
' 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

[C#] 
// 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
*/ 

[C++] 
// Example of the Convert::ToInt16( String* ) and 
// Convert::ToInt16( 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 ConvertToInt16( String* numericStr, IFormatProvider* provider )
{
    Object* defaultValue;
    Object* providerValue;

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

    // Convert numericStr to Int16 with a format provider.
    try
    {
        providerValue = __box( Convert::ToInt16( 
            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::ToInt16( String* ) and \n" 
        S"  Convert::ToInt16( String*, IFormatProvider* ) " 
        S"\ngenerates the following output. It converts " 
        S"several strings to \nshort 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.
    ConvertToInt16( S"12345", provider );
    ConvertToInt16( S"+12345", provider );
    ConvertToInt16( S"pos 12345", provider );
    ConvertToInt16( S"-12345", provider );
    ConvertToInt16( S"neg 12345", provider );
    ConvertToInt16( S"12345.", provider );
    ConvertToInt16( S"12,345", provider );
    ConvertToInt16( S"(12345)", provider );
    ConvertToInt16( S"32768", provider );
    ConvertToInt16( S"-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
*/ 

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

See Also

Convert Class | Convert Members | System Namespace

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft