Information
Switch
Switch
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 (String^, Int32)

.NET Framework (current version)
 

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

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

C#
C++
F#
VB
Copy 
public:
static short ToInt16(
	String^ value,
	int fromBase
)

Parameters

value
Type: System::String^

A string that contains the number to convert.

fromBase
Type: System::Int32

The base of the number in value, which must be 2, 8, 10, or 16.

Return Value

Type: System::Int16

A 16-bit signed integer that is equivalent to the number in value, or 0 (zero) if value is null.

Exception Condition
ArgumentException

fromBase is not 2, 8, 10, or 16.

-or-

value, which represents a non-base 10 signed number, is prefixed with a negative sign.

ArgumentOutOfRangeException

value is String::Empty.

FormatException

value contains a character that is not a valid digit in the base specified by fromBase. The exception message indicates that there are no digits to convert if the first character in value is invalid; otherwise, the message indicates that value contains invalid trailing characters.

OverflowException

value, which represents a non-base 10 signed number, is prefixed with a negative sign.

-or-

value represents a number that is less than Int16::MinValue or greater than Int16::MaxValue.

If fromBase is 16, you can prefix the number specified by the value parameter with "0x" or "0X".

Because the negative sign is not supported for non-base 10 numeric representations, the ToInt16(String^, Int32) method assumes that negative numbers use two’s complement representation. In other words, the method always interprets the highest-order binary bit of an integer (bit 15) as its sign bit. As a result, it is possible to write code in which a non-base 10 number that is out of the range of the Int16 data type is converted to an Int16 value without the method throwing an exception. The following example increments Int16::MaxValue by one, converts the resulting number to its hexadecimal string representation, and then calls the ToInt16(String^, Int32) method. Instead of throwing an exception, the method displays the message, "0x8000 converts to -32768."

C#
VB
C++
Copy
No code example is currently available or this language may not be supported.

When performing binary operations or numeric conversions, it is always the responsibility of the developer to verify that a method is using the appropriate numeric representation to interpret a particular value. As the following example illustrates, you can ensure that the method handles overflows appropriately by first retrieving the sign of the numeric value before converting it to its hexadecimal string representation. Throw an exception if the original value was positive but the conversion back to an integer yields a negative value.

C#
VB
C++
Copy
No code example is currently available or this language may not be supported.

The following example attempts to interpret each element in a string array as a hexadecimal string and to convert it to a 16-bit signed integer.

C#
VB
C++
Copy
No code example is currently available or this language may not be supported.

Universal Windows Platform
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
Return to top
Show: