Export (0) Print
Expand All

Convert.ToUInt16 Method (String)

Updated: May 2009

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

This API is not CLS-compliant. 

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

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

Parameters

value
Type: System.String

A string that contains the number to convert.

Return Value

Type: System.UInt16
A 16-bit unsigned integer that is equivalent to the number in value, or 0 (zero) if value is null.

ExceptionCondition
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 UInt16.MinValue or greater than UInt16.MaxValue.

The return value is the result of invoking UInt16.Parse on value.

If you prefer not to handle an exception if the conversion fails, you can call the UInt16.TryParse method instead. It returns a Boolean value that indicates whether the conversion succeeded or failed.

The following example attempts to convert each element in a numeric string array to a 16-bit unsigned integer.

string[] values = { "1603", "1,603", "one", "1.6e03", "1.2e-02", 
                    "-1326", "1074122" };
ushort result;

foreach (string 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 (FormatException) {
      Console.WriteLine("The {0} value {1} is not in a recognizable format.",
                        value.GetType().Name, value);
   }                     
   catch (OverflowException) {
      Console.WriteLine("{0} is outside the range of the UInt16 type.", value);
   }   
}
// The example displays the following output: 
//    Converted the String value '1603' to the UInt16 value 1603. 
//    The String value 1,603 is not in a recognizable format. 
//    The String value one is not in a recognizable format. 
//    The String value 1.6e03 is not in a recognizable format. 
//    The String value 1.2e-02 is not in a recognizable format. 
//    -1326 is outside the range of the UInt16 type. 
//    1074122 is outside the range of the UInt16 type.      

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98, Windows CE, Windows Mobile for Smartphone, Windows Mobile for Pocket PC, Xbox 360, Zune

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

.NET Framework

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

.NET Compact Framework

Supported in: 3.5, 2.0, 1.0

XNA Framework

Supported in: 3.0, 2.0, 1.0

Date

History

Reason

May 2009

Expanded the Remarks section.

Customer feedback.

Community Additions

ADD
Show:
© 2014 Microsoft