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
Assembly:  mscorlib (in mscorlib.dll)

<CLSCompliantAttribute(False)>
Public Shared Function ToUInt16 (
	value As Single
) As UShort

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.

Exception Condition
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.

Dim values() As Single = { Single.MinValue, -1.38e10, -1023.299, -12.98, _
                           0, 9.113e-16, 103.919, 17834.191, Single.MaxValue }
Dim result As UShort

For Each value As Single 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 e As OverflowException
      Console.WriteLine("{0} is outside the range of the UInt16 type.", value)
   End Try   
Next                                 
' 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.

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: