Convert.ToUInt16 Method (String, IFormatProvider)

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

This API is not CLS-compliant. 

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

public static ushort ToUInt16(
	string value,
	IFormatProvider provider


Type: System.String
A String containing a number to convert.
Type: System.IFormatProvider
An IFormatProvider interface implementation that supplies culture-specific formatting information.

Return Value

Type: System.UInt16
A 16-bit unsigned integer equivalent to the value of value.
Zero if value is null.


value does not consist of an optional sign followed by a sequence of digits (zero through nine).


value represents a number less than MinValue or greater than MaxValue.

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

provider is an IFormatProvider instance that obtains a NumberFormatInfo object. The NumberFormatInfo object provides culture-specific information about the format of value. If provider is null, the NumberFormatInfo for the current culture is used.

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 code example converts String representations of 16-bit unsigned integers with the ToUInt16 method, using an IFormatProvider object.

// Example of the Convert.ToUInt16( string ) and 
// Convert.ToUInt16( string, IFormatProvider ) methods.
using System;
using System.Globalization;

class Example
   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 ConvertToUInt16(System.Windows.Controls.TextBlock outputBlock, string numericStr,
       IFormatProvider provider)
      object defaultValue;
      object providerValue;

      // Convert numericStr to UInt16 without a format provider.
         defaultValue = Convert.ToUInt16(numericStr);
      catch (Exception ex)
         defaultValue = GetExceptionType(ex);

      // Convert numericStr to UInt16 with a format provider.
         providerValue = Convert.ToUInt16(numericStr, provider);
      catch (Exception ex)
         providerValue = GetExceptionType(ex);

      outputBlock.Text += String.Format(format, numericStr,
          defaultValue, providerValue) + "\n";

   public static void Demo(System.Windows.Controls.TextBlock outputBlock)
      // 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 };

      outputBlock.Text += String.Format("This example of\n" +
          "  Convert.ToUInt16( string ) and \n" +
          "  Convert.ToUInt16( string, IFormatProvider ) " +
          "\ngenerates the following output. It converts " +
          "several strings to \nushort values, using " +
          "default formatting or a NumberFormatInfo object.\n") + "\n";
      outputBlock.Text += String.Format(format, "String to convert",
          "Default/exception", "Provider/exception") + "\n";
      outputBlock.Text += String.Format(format, "-----------------",
          "-----------------", "------------------") + "\n";

      // Convert strings, with and without an IFormatProvider.
      ConvertToUInt16(outputBlock, "34567", provider);
      ConvertToUInt16(outputBlock, "+34567", provider);
      ConvertToUInt16(outputBlock, "pos 34567", provider);
      ConvertToUInt16(outputBlock, "34567.", provider);
      ConvertToUInt16(outputBlock, "34,567", provider);
      ConvertToUInt16(outputBlock, "65535", provider);
      ConvertToUInt16(outputBlock, "65536", provider);
      ConvertToUInt16(outputBlock, "-1", provider);

This example of
  Convert.ToUInt16( string ) and
  Convert.ToUInt16( string, IFormatProvider )
generates the following output. It converts several strings to
ushort values, using default formatting or a NumberFormatInfo object.

String to convert   Default/exception   Provider/exception
-----------------   -----------------   ------------------
34567               34567               34567
+34567              34567               FormatException
pos 34567           FormatException     34567
34567.              FormatException     FormatException
34,567              FormatException     FormatException
65535               65535               65535
65536               OverflowException   OverflowException
-1                  OverflowException   FormatException


Supported in: 5, 4, 3

Silverlight for Windows Phone

Supported in: Windows Phone OS 7.1, Windows Phone OS 7.0

XNA Framework

Supported in: Xbox 360, Windows Phone OS 7.0

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.

Community Additions