Convert.ToUInt16 Method (Object)

Converts the value of the specified object to a 16-bit unsigned integer.

This API is not CLS-compliant. 

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

[CLSCompliantAttribute(false)]
public static ushort ToUInt16(
	Object value
)

Parameters

value
Type: System.Object

An object that implements the IConvertible interface, or null.

Return Value

Type: System.UInt16
A 16-bit unsigned integer that is equivalent to value, or zero if value is null.

ExceptionCondition
FormatException

value is not in an appropriate format.

InvalidCastException

value does not implement the IConvertible interface.

-or-

The conversion is not supported.

OverflowException

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

The return value is the result of invoking the IConvertible.ToUInt16 method of the underlying type of value.

The following example attempts to convert each element in an object array to an unsigned 16-bit integer.

object[] values= { true, -12, 163, 935, 'x', new DateTime(2009, 5, 12),
                   "104", "103.0", "-1", "1.00e2", "One", 1.00e2};
ushort result;

foreach (object value in values)
{
   try {
      result = Convert.ToUInt16(value);
      Console.WriteLine("Converted the {0} value '{1}' to the {2} value {3}.", 
                        value.GetType().Name, value, 
                        result.GetType().Name, result);
   }                     
   catch (OverflowException) {
      Console.WriteLine("The {0} value {1} is outside the range of the UInt16 type.",
                        value.GetType().Name, value);
   }                     
   catch (FormatException) {
      Console.WriteLine("The {0} value {1} is not in a recognizable format.",
                        value.GetType().Name, value);
   }                     
   catch (InvalidCastException) {
      Console.WriteLine("No conversion to a UInt16 exists for the {0} value {1}.",
                        value.GetType().Name, value);
   }
}                           
// The example displays the following output: 
//    Converted the Boolean value 'True' to the UInt16 value 1. 
//    The Int32 value -12 is outside the range of the UInt16 type. 
//    Converted the Int32 value '163' to the UInt16 value 163. 
//    Converted the Int32 value '935' to the UInt16 value 935. 
//    Converted the Char value 'x' to the UInt16 value 120. 
//    No conversion to a UInt16 exists for the DateTime value 5/12/2009 12:00:00 AM. 
//    Converted the String value '104' to the UInt16 value 104. 
//    The String value 103.0 is not in a recognizable format. 
//    The String value -1 is outside the range of the UInt16 type. 
//    The String value 1.00e2 is not in a recognizable format. 
//    The String value One is not in a recognizable format. 
//    Converted the Double value '100' to the UInt16 value 100.

.NET Framework

Supported in: 4.6, 4.5, 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

.NET for Windows Store apps

Supported in: Windows 8

Supported in: Windows Phone 8.1

Supported in: Windows Phone Silverlight 8.1

Supported in: Windows Phone Silverlight 8

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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

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