This documentation is archived and is not being maintained.

BitConverter::ToInt16 Method

Returns a 16-bit signed integer converted from two bytes at a specified position in a byte array.

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

public:
static short ToInt16(
	array<unsigned char>^ value, 
	int startIndex
)

Parameters

value
Type: array<System::Byte>
An array of bytes.
startIndex
Type: System::Int32
The starting position within value.

Return Value

Type: System::Int16
A 16-bit signed integer formed by two bytes beginning at startIndex.

ExceptionCondition
ArgumentException

startIndex equals the length of value minus 1.

ArgumentNullException

value is nullptr.

ArgumentOutOfRangeException

startIndex is less than zero or greater than the length of value minus 1.

The following code example converts elements of Byte arrays to Int16 values with the ToInt16 method.


// Example of the BitConverter::ToInt16 method.
using namespace System;

// Convert two byte array elements to a short and display it.
void BAToInt16( array<unsigned char>^bytes, int index )
{
   short value = BitConverter::ToInt16( bytes, index );
   Console::WriteLine( "{0,5}{1,17}{2,10}", index, BitConverter::ToString( bytes, index, 2 ), value );
}

int main()
{
   array<unsigned char>^byteArray = {15,0,0,128,16,39,240,216,241,255,127};
   Console::WriteLine( "This example of the BitConverter::ToInt16( unsigned "
   "char[ ], int ) \nmethod generates the following output. It "
   "converts elements of a \nbyte array to short values.\n" );
   Console::WriteLine( "initial byte array" );
   Console::WriteLine( "------------------" );
   Console::WriteLine( BitConverter::ToString( byteArray ) );
   Console::WriteLine();
   Console::WriteLine( "{0,5}{1,17}{2,10}", "index", "array elements", "short" );
   Console::WriteLine( "{0,5}{1,17}{2,10}", "-----", "--------------", "-----" );

   // Convert byte array elements to short values.
   BAToInt16( byteArray, 1 );
   BAToInt16( byteArray, 0 );
   BAToInt16( byteArray, 8 );
   BAToInt16( byteArray, 4 );
   BAToInt16( byteArray, 6 );
   BAToInt16( byteArray, 9 );
   BAToInt16( byteArray, 2 );
}

/*
This example of the BitConverter::ToInt16( unsigned char[ ], int )
method generates the following output. It converts elements of a
byte array to short values.

initial byte array
------------------
0F-00-00-80-10-27-F0-D8-F1-FF-7F

index   array elements     short
-----   --------------     -----
    1            00-00         0
    0            0F-00        15
    8            F1-FF       -15
    4            10-27     10000
    6            F0-D8    -10000
    9            FF-7F     32767
    2            00-80    -32768
*/


.NET Framework

Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Portable Class Library

Supported in: Portable Class Library

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Show: