Export (0) Print
Expand All

BigInteger Explicit Conversion (BigInteger to UInt16)

Defines an explicit conversion of a BigInteger object to an unsigned 16-bit integer value.

This API is not CLS-compliant. The CLS-compliant alternative is System.Int32.

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

public static explicit operator ushort (
	BigInteger value
)

Parameters

value
Type: System.Numerics.BigInteger

The value to convert to an unsigned 16-bit integer.

Return Value

Type: System.UInt16
An object that contains the value of the value parameter

ExceptionCondition
OverflowException

value is less than UInt16.MinValue.

-or-

value is greater than UInt16.MaxValue.

The overloads of the Explicit method define the types to which or from which a BigInteger object can be converted. Language compilers do not perform this conversion automatically because it can involve data loss. Instead, they perform the conversion only if a casting operator (in C#) or a conversion function (such as CType or CUShort in Visual Basic) is used. Otherwise, they display a compiler error.

Because this operation defines a narrowing conversion, it can throw an OverflowException at run time if the BigInteger value is outside the range of the UInt16 data type. There is no loss of precision in the resulting UInt16 value if the conversion is successful.

The following example illustrates the conversion of BigInteger values to UInt16 values. It also handles an OverflowException that is thrown because the BigInteger value is outside the range of the UInt16 data type.

// BigInteger to UInt16 conversion.
BigInteger goodUShort = 20000;
BigInteger badUShort = 66000;

ushort uShortFromBigInteger;

// Successful conversion using cast operator. 
uShortFromBigInteger = (ushort) goodUShort;
Console.WriteLine(uShortFromBigInteger);

// Handle conversion that should result in overflow. 
try
{
   uShortFromBigInteger = (ushort) badUShort;
   Console.WriteLine(uShortFromBigInteger);
}
catch (OverflowException e)
{
   Console.WriteLine("Unable to convert {0}:\n   {1}", 
                     badUShort, e.Message);
}
Console.WriteLine();

.NET Framework

Supported in: 4.6, 4.5, 4

.NET Framework Client Profile

Supported in: 4

Portable Class Library

Supported in: Portable Class Library

Supported in: Windows Phone 8.1
Show:
© 2015 Microsoft