Decimal.ToUInt16 Method

Microsoft Silverlight will reach end of support after October 2021. Learn more.

Converts the value of the specified Decimal to the equivalent 16-bit unsigned integer.

This API is not CLS-compliant. The CLS-compliant alternative is ToInt32(Decimal).

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

Syntax

'Declaration
<CLSCompliantAttribute(False)> _
Public Shared Function ToUInt16 ( _
    value As Decimal _
) As UShort
[CLSCompliantAttribute(false)]
public static ushort ToUInt16(
    decimal value
)

Parameters

Return Value

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

Exceptions

Exception Condition
OverflowException

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

Remarks

The return value is the integral part of the decimal value; fractional digits are truncated.

Examples

The following code example converts Decimal numbers to UInt16 values using the ToUInt16 method.

' Example of the Decimal.ToInt16 and Decimal.ToUInt16 methods.

Module Example

   Dim formatter As String = "{0,16}{1,19}{2,19}"

   ' Get the exception type name; remove the namespace prefix.
   Function GetExceptionType(ByVal ex As Exception) As String

      Dim exceptionType As String = ex.GetType().ToString()
      Return exceptionType.Substring( _
          exceptionType.LastIndexOf("."c) + 1)
   End Function

   ' Convert the Decimal argument; catch exceptions that are thrown.
   Sub DecimalToU_Int16(ByVal outputBlock As System.Windows.Controls.TextBlock, ByVal argument As Decimal)

      Dim Int16Value As Object
      Dim UInt16Value As Object

      ' Convert the argument to a Short value.
      Try
         Int16Value = Decimal.ToInt16(argument)
      Catch ex As Exception
         Int16Value = GetExceptionType(ex)
      End Try

      ' Convert the argument to a UInt16 value.
      Try
         UInt16Value = Decimal.ToUInt16(argument)
      Catch ex As Exception
         UInt16Value = GetExceptionType(ex)
      End Try

      outputBlock.Text &= String.Format(formatter, argument, _
          Int16Value, UInt16Value) & vbCrLf
   End Sub

   Public Sub Demo(ByVal outputBlock As System.Windows.Controls.TextBlock)

      outputBlock.Text &= String.Format("This example of the " & vbCrLf & _
          "  Decimal.ToInt16( Decimal ) and " & vbCrLf & _
          "  Decimal.ToUInt16( Decimal ) " & vbCrLf & "methods " & _
          "generates the following output. It " & vbCrLf & _
          "displays several converted Decimal values." & vbCrLf) & vbCrLf
      outputBlock.Text &= String.Format(formatter, "Decimal argument", _
          "Short/exception", "UInt16/exception") & vbCrLf
      outputBlock.Text &= String.Format(formatter, "----------------", _
          "---------------", "----------------") & vbCrLf

      ' Convert Decimal values and display the results.
      DecimalToU_Int16(outputBlock, 123D)
      DecimalToU_Int16(outputBlock, New Decimal(123000, 0, 0, False, 3))
      DecimalToU_Int16(outputBlock, 123.999D)
      DecimalToU_Int16(outputBlock, 65535.999D)
      DecimalToU_Int16(outputBlock, 65536D)
      DecimalToU_Int16(outputBlock, 32767.999D)
      DecimalToU_Int16(outputBlock, 32768D)
      DecimalToU_Int16(outputBlock, -0.999D)
      DecimalToU_Int16(outputBlock, -1D)
      DecimalToU_Int16(outputBlock, -32768.999D)
      DecimalToU_Int16(outputBlock, -32769D)
   End Sub
End Module

' This example of the
'   Decimal.ToInt16( Decimal ) and
'   Decimal.ToUInt16( Decimal )
' methods generates the following output. It
' displays several converted Decimal values.
' 
' Decimal argument    Short/exception   UInt16/exception
' ----------------    ---------------   ----------------
'              123                123                123
'          123.000                123                123
'          123.999                123                123
'        65535.999  OverflowException              65535
'            65536  OverflowException  OverflowException
'        32767.999              32767              32767
'            32768  OverflowException              32768
'           -0.999                  0                  0
'               -1                 -1  OverflowException
'       -32768.999             -32768  OverflowException
'           -32769  OverflowException  OverflowException
// Example of the decimal.ToInt16 and decimal.ToUInt16 methods.
using System;

class Example
{
   const string formatter = "{0,16}{1,19}{2,19}";

   // Get the exception type name; remove the namespace prefix.
   public static string GetExceptionType(Exception ex)
   {
      string exceptionType = ex.GetType().ToString();
      return exceptionType.Substring(
          exceptionType.LastIndexOf('.') + 1);
   }

   // Convert the decimal argument; catch exceptions that are thrown.
   public static void DecimalToU_Int16(System.Windows.Controls.TextBlock outputBlock, decimal argument)
   {
      object Int16Value;
      object UInt16Value;

      // Convert the argument to a short value.
      try
      {
         Int16Value = decimal.ToInt16(argument);
      }
      catch (Exception ex)
      {
         Int16Value = GetExceptionType(ex);
      }

      // Convert the argument to a ushort value.
      try
      {
         UInt16Value = decimal.ToUInt16(argument);
      }
      catch (Exception ex)
      {
         UInt16Value = GetExceptionType(ex);
      }

      outputBlock.Text += String.Format(formatter, argument,
          Int16Value, UInt16Value) + "\n";
   }

   public static void Demo(System.Windows.Controls.TextBlock outputBlock)
   {
      outputBlock.Text += String.Format("This example of the \n" +
          "  decimal.ToInt16( decimal ) and \n" +
          "  decimal.ToUInt16( decimal ) \nmethods " +
          "generates the following output. It \ndisplays " +
          "several converted decimal values.\n") + "\n";
      outputBlock.Text += String.Format(formatter, "decimal argument",
          "short/exception", "ushort/exception") + "\n";
      outputBlock.Text += String.Format(formatter, "----------------",
          "---------------", "----------------") + "\n";

      // Convert decimal values and display the results.
      DecimalToU_Int16(outputBlock, 123M);
      DecimalToU_Int16(outputBlock, new decimal(123000, 0, 0, false, 3));
      DecimalToU_Int16(outputBlock, 123.999M);
      DecimalToU_Int16(outputBlock, 65535.999M);
      DecimalToU_Int16(outputBlock, 65536M);
      DecimalToU_Int16(outputBlock, 32767.999M);
      DecimalToU_Int16(outputBlock, 32768M);
      DecimalToU_Int16(outputBlock, -0.999M);
      DecimalToU_Int16(outputBlock, -1M);
      DecimalToU_Int16(outputBlock, -32768.999M);
      DecimalToU_Int16(outputBlock, -32769M);
   }
}

/*
This example of the
  decimal.ToInt16( decimal ) and
  decimal.ToUInt16( decimal )
methods generates the following output. It
displays several converted decimal values.

decimal argument    short/exception   ushort/exception
----------------    ---------------   ----------------
             123                123                123
         123.000                123                123
         123.999                123                123
       65535.999  OverflowException              65535
           65536  OverflowException  OverflowException
       32767.999              32767              32767
           32768  OverflowException              32768
          -0.999                  0                  0
              -1                 -1  OverflowException
      -32768.999             -32768  OverflowException
          -32769  OverflowException  OverflowException
*/

Version Information

Silverlight

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

Platforms

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