Convert.ToUInt16 Method (Single)

Converts the value of the specified single-precision floating-point number to an equivalent 16-bit unsigned integer.

This API is not CLS-compliant. 

Namespace:  System
Assemblies:   System.Runtime.Extensions (in System.Runtime.Extensions.dll)
  mscorlib (in mscorlib.dll)

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

Parameters

value
Type: System.Single

The single-precision floating-point number to convert.

Return Value

Type: System.UInt16
value, rounded to the nearest 16-bit unsigned integer. If value is halfway between two whole numbers, the even number is returned; that is, 4.5 is converted to 4, and 5.5 is converted to 6.

ExceptionCondition
OverflowException

value is less than zero or greater than UInt16.MaxValue.

The following example converts each element in an array of String values to an unsigned 16-bit integer.

float[] numbers = { Single.MinValue, -1.38e10f, -1023.299f, -12.98f,
                   0f, 9.113e-16f, 103.919f, 17834.191f, Single.MaxValue };
ushort result;

foreach (float number in numbers)
{
   try {
      result = Convert.ToUInt16(number);
      Console.WriteLine("Converted the {0} value '{1}' to the {2} value {3}.", 
                        number.GetType().Name, number, 
                        result.GetType().Name, result);
   }                     
   catch (OverflowException) {
      Console.WriteLine("{0} is outside the range of the UInt16 type.", number);
   }   
}                                 
// The example displays the following output: 
//    -3.402823E+38 is outside the range of the UInt16 type. 
//    -1.38E+10 is outside the range of the UInt16 type. 
//    -1023.299 is outside the range of the UInt16 type. 
//    -12.98 is outside the range of the UInt16 type. 
//    Converted the Single value '0' to the UInt16 value 0. 
//    Converted the Single value '9.113E-16' to the UInt16 value 0. 
//    Converted the Single value '103.919' to the UInt16 value 104. 
//    Converted the Single value '17834.19' to the UInt16 value 17834. 
//    3.402823E+38 is outside the range of the UInt16 type.

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0, 2.0, 1.1

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

XNA Framework

Supported in: 3.0, 2.0, 1.0

Portable Class Library

Supported in: Portable Class Library

Supported in: Windows Phone 8.1

Supported in: Windows Phone Silverlight 8.1

Supported in: Windows Phone Silverlight 8
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2015 Microsoft