Convert.ToUInt16 Method
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Converts a specified value to a 16-bit unsigned integer.
ToUInt16(String) |
Converts the specified string representation of a number to an equivalent 16-bit unsigned integer. |
ToUInt16(UInt16) |
Returns the specified 16-bit unsigned integer; no actual conversion is performed. |
ToUInt16(UInt32) |
Converts the value of the specified 32-bit unsigned integer to an equivalent 16-bit unsigned integer. |
ToUInt16(String, Int32) |
Converts the string representation of a number in a specified base to an equivalent 16-bit unsigned integer. |
ToUInt16(Object, IFormatProvider) |
Converts the value of the specified object to a 16-bit unsigned integer, using the specified culture-specific formatting information. |
ToUInt16(String, IFormatProvider) |
Converts the specified string representation of a number to an equivalent 16-bit unsigned integer, using the specified culture-specific formatting information. |
ToUInt16(Single) |
Converts the value of the specified single-precision floating-point number to an equivalent 16-bit unsigned integer. |
ToUInt16(UInt64) |
Converts the value of the specified 64-bit unsigned integer to an equivalent 16-bit unsigned integer. |
ToUInt16(SByte) |
Converts the value of the specified 8-bit signed integer to the equivalent 16-bit unsigned integer. |
ToUInt16(Char) |
Converts the value of the specified Unicode character to the equivalent 16-bit unsigned integer. |
ToUInt16(Int64) |
Converts the value of the specified 64-bit signed integer to an equivalent 16-bit unsigned integer. |
ToUInt16(Int32) |
Converts the value of the specified 32-bit signed integer to an equivalent 16-bit unsigned integer. |
ToUInt16(Int16) |
Converts the value of the specified 16-bit signed integer to the equivalent 16-bit unsigned integer. |
ToUInt16(Decimal) |
Converts the value of the specified decimal number to an equivalent 16-bit unsigned integer. |
ToUInt16(DateTime) |
Calling this method always throws InvalidCastException. |
ToUInt16(Byte) |
Converts the value of the specified 8-bit unsigned integer to the equivalent 16-bit unsigned integer. |
ToUInt16(Boolean) |
Converts the specified Boolean value to the equivalent 16-bit unsigned integer. |
ToUInt16(Object) |
Converts the value of the specified object to a 16-bit unsigned integer. |
ToUInt16(Double) |
Converts the value of the specified double-precision floating-point number to an equivalent 16-bit unsigned integer. |
- Source:
- Convert.cs
- Source:
- Convert.cs
- Source:
- Convert.cs
Important
This API is not CLS-compliant.
Converts the specified string representation of a number to an equivalent 16-bit unsigned integer.
public:
static System::UInt16 ToUInt16(System::String ^ value);
[System.CLSCompliant(false)]
public static ushort ToUInt16 (string value);
[System.CLSCompliant(false)]
public static ushort ToUInt16 (string? value);
[<System.CLSCompliant(false)>]
static member ToUInt16 : string -> uint16
Public Shared Function ToUInt16 (value As String) As UShort
Parameters
- value
- String
A string that contains the number to convert.
Returns
A 16-bit unsigned integer that is equivalent to the number in value
, or 0 (zero) if value
is null
.
- Attributes
Exceptions
value
does not consist of an optional sign followed by a sequence of digits (0 through 9).
value
represents a number that is less than UInt16.MinValue or greater than UInt16.MaxValue.
Examples
The following example attempts to convert each element in a numeric string array to a 16-bit unsigned integer.
string[] values = { "1603", "1,603", "one", "1.6e03", "1.2e-02",
"-1326", "1074122" };
ushort result;
foreach (string value 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 (FormatException) {
Console.WriteLine("The {0} value {1} is not in a recognizable format.",
value.GetType().Name, value);
}
catch (OverflowException) {
Console.WriteLine("{0} is outside the range of the UInt16 type.", value);
}
}
// The example displays the following output:
// Converted the String value '1603' to the UInt16 value 1603.
// The String value 1,603 is not in a recognizable format.
// The String value one is not in a recognizable format.
// The String value 1.6e03 is not in a recognizable format.
// The String value 1.2e-02 is not in a recognizable format.
// -1326 is outside the range of the UInt16 type.
// 1074122 is outside the range of the UInt16 type.
let values =
[| "1603"; "1,603"; "one"; "1.6e03"
"1.2e-02"; "-1326"; "1074122" |]
for value in values do
try
let result = Convert.ToUInt16 value
printfn $"Converted the {value.GetType().Name} value '{value}' to the {result.GetType().Name} value {result}."
with
| :? FormatException ->
printfn $"The {value.GetType().Name} value {value} is not in a recognizable format."
| :? OverflowException ->
printfn $"{value} is outside the range of the UInt16 type."
// The example displays the following output:
// Converted the String value '1603' to the UInt16 value 1603.
// The String value 1,603 is not in a recognizable format.
// The String value one is not in a recognizable format.
// The String value 1.6e03 is not in a recognizable format.
// The String value 1.2e-02 is not in a recognizable format.
// -1326 is outside the range of the UInt16 type.
// 1074122 is outside the range of the UInt16 type.
Dim values() As String = { "1603", "1,603", "one", "1.6e03", "1.2e-02", _
"-1326", "1074122" }
Dim result As UShort
For Each value As String 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 FormatException
Console.WriteLine("The {0} value {1} is not in a recognizable format.", _
value.GetType().Name, value)
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:
' Converted the String value '1603' to the UInt16 value 1603.
' The String value 1,603 is not in a recognizable format.
' The String value one is not in a recognizable format.
' The String value 1.6e03 is not in a recognizable format.
' The String value 1.2e-02 is not in a recognizable format.
' -1326 is outside the range of the UInt16 type.
' 1074122 is outside the range of the UInt16 type.
Remarks
Using the ToUInt16(String) method is equivalent to passing value
to the UInt16.Parse(String) method. value
is interpreted by using the formatting conventions of the current culture.
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.
Applies to
.NET 9 and other versions
Product | Versions |
---|---|
.NET | Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9 |
.NET Framework | 1.1, 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1 |
.NET Standard | 1.0, 1.1, 1.2, 1.3, 1.4, 1.5, 1.6, 2.0, 2.1 |
UWP | 10.0 |
- Source:
- Convert.cs
- Source:
- Convert.cs
- Source:
- Convert.cs
Important
This API is not CLS-compliant.
Returns the specified 16-bit unsigned integer; no actual conversion is performed.
public:
static System::UInt16 ToUInt16(System::UInt16 value);
[System.CLSCompliant(false)]
public static ushort ToUInt16 (ushort value);
[<System.CLSCompliant(false)>]
static member ToUInt16 : uint16 -> uint16
Public Shared Function ToUInt16 (value As UShort) As UShort
Parameters
- value
- UInt16
The 16-bit unsigned integer to return.
Returns
value
is returned unchanged.
- Attributes
Applies to
.NET 9 and other versions
Product | Versions |
---|---|
.NET | Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9 |
.NET Framework | 1.1, 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1 |
.NET Standard | 1.0, 1.1, 1.2, 1.3, 1.4, 1.5, 1.6, 2.0, 2.1 |
UWP | 10.0 |
- Source:
- Convert.cs
- Source:
- Convert.cs
- Source:
- Convert.cs
Important
This API is not CLS-compliant.
Converts the value of the specified 32-bit unsigned integer to an equivalent 16-bit unsigned integer.
public:
static System::UInt16 ToUInt16(System::UInt32 value);
[System.CLSCompliant(false)]
public static ushort ToUInt16 (uint value);
[<System.CLSCompliant(false)>]
static member ToUInt16 : uint32 -> uint16
Public Shared Function ToUInt16 (value As UInteger) As UShort
Parameters
- value
- UInt32
The 32-bit unsigned integer to convert.
Returns
A 16-bit unsigned integer that is equivalent to value
.
- Attributes
Exceptions
value
is greater than UInt16.MaxValue.
Examples
The following example attempts to convert each element in an array of unsigned integers to an unsigned 16-bit integer.
uint[] numbers = { UInt32.MinValue, 121, 340, UInt32.MaxValue };
ushort result;
foreach (uint 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("The {0} value {1} is outside the range of the UInt16 type.",
number.GetType().Name, number);
}
}
// The example displays the following output:
// Converted the UInt32 value '0' to the UInt16 value 0.
// Converted the UInt32 value '121' to the UInt16 value 121.
// Converted the UInt32 value '340' to the UInt16 value 340.
// The UInt32 value 4294967295 is outside the range of the UInt16 type.
let numbers = [| UInt32.MinValue; 121u; 340u; UInt32.MaxValue |]
for number in numbers do
try
let result = Convert.ToUInt16 number
printfn $"Converted the {number.GetType().Name} value '{number}' to the {result.GetType().Name} value {result}."
with :? OverflowException ->
printfn $"The {number.GetType().Name} value {number} is outside the range of the UInt16 type."
// The example displays the following output:
// Converted the UInt32 value '0' to the UInt16 value 0.
// Converted the UInt32 value '121' to the UInt16 value 121.
// Converted the UInt32 value '340' to the UInt16 value 340.
// The UInt32 value 4294967295 is outside the range of the UInt16 type.
Dim numbers() As UInteger = { UInt32.MinValue, 121, 340, UInt32.MaxValue }
Dim result As UShort
For Each number As UInteger 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 e As OverflowException
Console.WriteLine("The {0} value {1} is outside the range of the UInt16 type.", _
number.GetType().Name, number)
End Try
Next
' The example displays the following output:
' Converted the UInt32 value '0' to the UInt16 value 0.
' Converted the UInt32 value '121' to the UInt16 value 121.
' Converted the UInt32 value '340' to the UInt16 value 340.
' The UInt32 value 4294967295 is outside the range of the UInt16 type.
Applies to
.NET 9 and other versions
Product | Versions |
---|---|
.NET | Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9 |
.NET Framework | 1.1, 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1 |
.NET Standard | 1.0, 1.1, 1.2, 1.3, 1.4, 1.5, 1.6, 2.0, 2.1 |
UWP | 10.0 |
- Source:
- Convert.cs
- Source:
- Convert.cs
- Source:
- Convert.cs
Important
This API is not CLS-compliant.
Converts the string representation of a number in a specified base to an equivalent 16-bit unsigned integer.
public:
static System::UInt16 ToUInt16(System::String ^ value, int fromBase);
[System.CLSCompliant(false)]
public static ushort ToUInt16 (string value, int fromBase);
[System.CLSCompliant(false)]
public static ushort ToUInt16 (string? value, int fromBase);
[<System.CLSCompliant(false)>]
static member ToUInt16 : string * int -> uint16
Public Shared Function ToUInt16 (value As String, fromBase As Integer) As UShort
Parameters
- value
- String
A string that contains the number to convert.
- fromBase
- Int32
The base of the number in value
, which must be 2, 8, 10, or 16.
Returns
A 16-bit unsigned integer that is equivalent to the number in value
, or 0 (zero) if value
is null
.
- Attributes
Exceptions
fromBase
is not 2, 8, 10, or 16.
-or-
value
, which represents a non-base 10 unsigned number, is prefixed with a negative sign.
value
is Empty.
value
contains a character that is not a valid digit in the base specified by fromBase
. The exception message indicates that there are no digits to convert if the first character in value
is invalid; otherwise, the message indicates that value
contains invalid trailing characters.
value
, which represents a non-base 10 unsigned number, is prefixed with a negative sign.
-or-
value
represents a number that is less than UInt16.MinValue or greater than UInt16.MaxValue.
Examples
The following example attempts to interpret each element in an array of numeric strings as a hexadecimal value and to convert it to an unsigned 16-bit integer.
using System;
public class Example
{
public static void Main()
{
string[] hexStrings = { "8000", "0FFF", "f000", "00A30", "D", "-13",
"9AC61", "GAD" };
foreach (string hexString in hexStrings)
{
try {
ushort number = Convert.ToUInt16(hexString, 16);
Console.WriteLine("Converted '{0}' to {1:N0}.", hexString, number);
}
catch (FormatException) {
Console.WriteLine("'{0}' is not in the correct format for a hexadecimal number.",
hexString);
}
catch (OverflowException) {
Console.WriteLine("'{0}' is outside the range of an Int16.", hexString);
}
catch (ArgumentException) {
Console.WriteLine("'{0}' is invalid in base 16.", hexString);
}
}
}
}
// The example displays the following output:
// Converted '8000' to 32,768.
// Converted '0FFF' to 4,095.
// Converted 'f000' to 61,440.
// Converted '00A30' to 2,608.
// Converted 'D' to 13.
// '-13' is invalid in base 16.
// '9AC61' is outside the range of an Int16.
// 'GAD' is not in the correct format for a hexadecimal number.
open System
let hexStrings =
[| "8000"; "0FFF"; "f000"; "00A30"
"D"; "-13"; "9AC61"; "GAD" |]
for hexString in hexStrings do
try
let number = Convert.ToUInt16(hexString, 16)
printfn $"Converted '{hexString}' to {number:N0}."
with
| :? FormatException ->
printfn $"'{hexString}' is not in the correct format for a hexadecimal number."
| :? OverflowException ->
printfn $"'{hexString}' is outside the range of an Int16."
| :? ArgumentException ->
printfn $"'{hexString}' is invalid in base 16."
// The example displays the following output:
// Converted '8000' to 32,768.
// Converted '0FFF' to 4,095.
// Converted 'f000' to 61,440.
// Converted '00A30' to 2,608.
// Converted 'D' to 13.
// '-13' is invalid in base 16.
// '9AC61' is outside the range of an Int16.
// 'GAD' is not in the correct format for a hexadecimal number.
Module Example
Public Sub Main()
Dim hexStrings() As String = { "8000", "0FFF", "f000", "00A30", "D", _
"-13", "9AC61", "GAD" }
For Each hexString As String In hexStrings
Try
Dim number As UShort = Convert.ToUInt16(hexString, 16)
Console.WriteLine("Converted '{0}' to {1:N0}.", hexString, number)
Catch e As FormatException
Console.WriteLine("'{0}' is not in the correct format for a hexadecimal number.", _
hexString)
Catch e As OverflowException
Console.WriteLine("'{0}' is outside the range of an Int16.", hexString)
Catch e As ArgumentException
Console.WriteLine("'{0}' is invalid in base 16.", hexString)
End Try
Next
End Sub
End Module
' ' The example displays the following output:
' Converted '8000' to 32,768.
' Converted '0FFF' to 4,095.
' Converted 'f000' to 61,440.
' Converted '00A30' to 2,608.
' Converted 'D' to 13.
' '-13' is invalid in base 16.
' '9AC61' is outside the range of an Int16.
' 'GAD' is not in the correct format for a hexadecimal number.
Remarks
If fromBase
is 16, you can prefix the number specified by the value
parameter with "0x" or "0X".
Because the UInt16 data type supports unsigned values only, the ToUInt16(String, Int32) method assumes that value
is expressed using unsigned binary representation. In other words, all 16 bits are used to represent the numeric value, and a sign bit is absent. As a result, it is possible to write code in which a signed integer value that is out of the range of the UInt16 data type is converted to a UInt16 value without the method throwing an exception. The following example converts Int16.MinValue to its hexadecimal string representation, and then calls the ToUInt16(String, Int32) method. Instead of throwing an exception, the method displays the message, "0x8000 converts to 32768."
// Create a hexadecimal value out of range of the UInt16 type.
string value = Convert.ToString(Int16.MinValue, 16);
// Convert it back to a number.
try
{
UInt16 number = Convert.ToUInt16(value, 16);
Console.WriteLine("0x{0} converts to {1}.", value, number);
}
catch (OverflowException)
{
Console.WriteLine("Unable to convert '0x{0}' to an unsigned short integer.",
value);
}
// Create a hexadecimal value out of range of the UInt16 type.
let value = Convert.ToString(Int16.MinValue, 16)
// Convert it back to a number.
try
let number = Convert.ToUInt16(value, 16)
printfn $"0x{value} converts to {number}."
with :? OverflowException ->
printfn $"Unable to convert '0x{value}' to an unsigned short integer."
' Create a hexadecimal value out of range of the UInt16 type.
Dim value As String = Convert.ToString(Short.MinValue, 16)
' Convert it back to a number.
Try
Dim number As UInt16 = Convert.ToUInt16(value, 16)
Console.WriteLine("0x{0} converts to {1}.", value, number)
Catch e As OverflowException
Console.WriteLine("Unable to convert '0x{0}' to an unsigned short integer.", _
value)
End Try
When performing binary operations or numeric conversions, it is always the responsibility of the developer to verify that a method or operator is using the appropriate numeric representation to interpret a particular value. The following example illustrates one technique for ensuring that the method does not inappropriately use binary representation to interpret a value that uses two's complement representation when converting a hexadecimal string to a UInt16 value. The example determines whether a value represents a signed or an unsigned integer while it is converting that value to its string representation. When the example converts the value to a UInt16 value, it checks whether the original value was a signed integer. If so, and if its high-order bit is set (which indicates that the original value was negative), the method throws an exception.
// Create a negative hexadecimal value out of range of the UInt16 type.
short sourceNumber = Int16.MinValue;
bool isSigned = Math.Sign((short)sourceNumber.GetType().GetField("MinValue").GetValue(null)) == -1;
string value = Convert.ToString(sourceNumber, 16);
UInt16 targetNumber;
try
{
targetNumber = Convert.ToUInt16(value, 16);
if (isSigned && ((targetNumber & 0x8000) != 0))
throw new OverflowException();
else
Console.WriteLine("0x{0} converts to {1}.", value, targetNumber);
}
catch (OverflowException)
{
Console.WriteLine("Unable to convert '0x{0}' to an unsigned short integer.", value);
}
// Displays the following to the console:
// Unable to convert '0x8000' to an unsigned short integer.
// Create a negative hexadecimal value out of range of the UInt16 type.
let sourceNumber = Int16.MinValue
let isSigned = sign (sourceNumber.GetType().GetField("MinValue").GetValue null :?> int16) = -1
let value = Convert.ToString(sourceNumber, 16)
try
let targetNumber = Convert.ToUInt16(value, 16)
if isSigned && targetNumber &&& 0x8000us <> 0us then
raise (OverflowException())
else
printfn $"0x{value} converts to {targetNumber}."
with :? OverflowException ->
printfn $"Unable to convert '0x{value}' to an unsigned short integer."
// Displays the following to the console:
// Unable to convert '0x8000' to an unsigned short integer.
' Create a negative hexadecimal value out of range of the UInt16 type.
Dim sourceNumber As Short = Short.MinValue
Dim isSigned As Boolean = Math.Sign(sourceNumber.MinValue) = -1
Dim value As String = Convert.ToString(sourceNumber, 16)
Dim targetNumber As UInt16
Try
targetNumber = Convert.ToUInt16(value, 16)
If isSigned And ((targetNumber And &H8000) <> 0) Then
Throw New OverflowException()
Else
Console.WriteLine("0x{0} converts to {1}.", value, targetNumber)
End If
Catch e As OverflowException
Console.WriteLine("Unable to convert '0x{0}' to an unsigned short integer.", _
value)
End Try
' Displays the following to the console:
' Unable to convert '0x8000' to an unsigned short integer.
Applies to
.NET 9 and other versions
Product | Versions |
---|---|
.NET | Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9 |
.NET Framework | 1.1, 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1 |
.NET Standard | 1.0, 1.1, 1.2, 1.3, 1.4, 1.5, 1.6, 2.0, 2.1 |
UWP | 10.0 |
- Source:
- Convert.cs
- Source:
- Convert.cs
- Source:
- Convert.cs
Important
This API is not CLS-compliant.
Converts the value of the specified object to a 16-bit unsigned integer, using the specified culture-specific formatting information.
public:
static System::UInt16 ToUInt16(System::Object ^ value, IFormatProvider ^ provider);
[System.CLSCompliant(false)]
public static ushort ToUInt16 (object value, IFormatProvider provider);
[System.CLSCompliant(false)]
public static ushort ToUInt16 (object? value, IFormatProvider? provider);
[<System.CLSCompliant(false)>]
static member ToUInt16 : obj * IFormatProvider -> uint16
Public Shared Function ToUInt16 (value As Object, provider As IFormatProvider) As UShort
Parameters
- value
- Object
An object that implements the IConvertible interface.
- provider
- IFormatProvider
An object that supplies culture-specific formatting information.
Returns
A 16-bit unsigned integer that is equivalent to value
, or zero if value
is null
.
- Attributes
Exceptions
value
is not in an appropriate format.
value
represents a number that is less than UInt16.MinValue or greater than UInt16.MaxValue.
Examples
The following example defines a HexString
class that implements the IConvertible interface and that is designed to hold the string representation of both 16-bit signed and 16-bit unsigned values. The class includes a Sign
property that indicates the sign of its hexadecimal value.
using System;
using System.Globalization;
using System.Text.RegularExpressions;
public enum SignBit { Negative=-1, Zero=0, Positive=1 };
public struct HexString : IConvertible
{
private SignBit signBit;
private string hexString;
public SignBit Sign
{
set { signBit = value; }
get { return signBit; }
}
public string Value
{
set {
if (value.Trim().Length > 4)
throw new ArgumentException("The string representation of a 160bit integer cannot have more than four characters.");
else if (! Regex.IsMatch(value, "([0-9,A-F]){1,4}", RegexOptions.IgnoreCase))
throw new ArgumentException("The hexadecimal representation of a 16-bit integer contains invalid characters.");
else
hexString = value;
}
get { return hexString; }
}
// IConvertible implementations.
public TypeCode GetTypeCode() {
return TypeCode.Object;
}
public bool ToBoolean(IFormatProvider provider)
{
return signBit != SignBit.Zero;
}
public byte ToByte(IFormatProvider provider)
{
if (signBit == SignBit.Negative)
throw new OverflowException(String.Format("{0} is out of range of the Byte type.", Convert.ToInt16(hexString, 16)));
else
try {
return Convert.ToByte(UInt16.Parse(hexString, NumberStyles.HexNumber));
}
catch (OverflowException e) {
throw new OverflowException(String.Format("{0} is out of range of the UInt16 type.", Convert.ToUInt16(hexString, 16)), e);
}
}
public char ToChar(IFormatProvider provider)
{
if (signBit == SignBit.Negative) {
throw new OverflowException(String.Format("{0} is out of range of the Char type.", Convert.ToInt16(hexString, 16)));
}
UInt16 codePoint = UInt16.Parse(this.hexString, NumberStyles.HexNumber);
return Convert.ToChar(codePoint);
}
public DateTime ToDateTime(IFormatProvider provider)
{
throw new InvalidCastException("Hexadecimal to DateTime conversion is not supported.");
}
public decimal ToDecimal(IFormatProvider provider)
{
if (signBit == SignBit.Negative)
{
short hexValue = Int16.Parse(hexString, NumberStyles.HexNumber);
return Convert.ToDecimal(hexValue);
}
else
{
ushort hexValue = UInt16.Parse(hexString, NumberStyles.HexNumber);
return Convert.ToDecimal(hexValue);
}
}
public double ToDouble(IFormatProvider provider)
{
if (signBit == SignBit.Negative)
return Convert.ToDouble(Int16.Parse(hexString, NumberStyles.HexNumber));
else
return Convert.ToDouble(UInt16.Parse(hexString, NumberStyles.HexNumber));
}
public short ToInt16(IFormatProvider provider)
{
if (signBit == SignBit.Negative)
return Int16.Parse(hexString, NumberStyles.HexNumber);
else
try {
return Convert.ToInt16(UInt16.Parse(hexString, NumberStyles.HexNumber));
}
catch (OverflowException e) {
throw new OverflowException(String.Format("{0} is out of range of the Int16 type.",
Convert.ToUInt16(hexString, 16)), e);
}
}
public int ToInt32(IFormatProvider provider)
{
if (signBit == SignBit.Negative)
return Convert.ToInt32(Int16.Parse(hexString, NumberStyles.HexNumber));
else
return Convert.ToInt32(UInt16.Parse(hexString, NumberStyles.HexNumber));
}
public long ToInt64(IFormatProvider provider)
{
if (signBit == SignBit.Negative)
return Convert.ToInt64(Int16.Parse(hexString, NumberStyles.HexNumber));
else
return Int64.Parse(hexString, NumberStyles.HexNumber);
}
public sbyte ToSByte(IFormatProvider provider)
{
if (signBit == SignBit.Negative)
try {
return Convert.ToSByte(Int16.Parse(hexString, NumberStyles.HexNumber));
}
catch (OverflowException e) {
throw new OverflowException(String.Format("{0} is outside the range of the SByte type.",
Int16.Parse(hexString, NumberStyles.HexNumber), e));
}
else
try {
return Convert.ToSByte(UInt16.Parse(hexString, NumberStyles.HexNumber));
}
catch (OverflowException e) {
throw new OverflowException(String.Format("{0} is outside the range of the SByte type.",
UInt16.Parse(hexString, NumberStyles.HexNumber)), e);
}
}
public float ToSingle(IFormatProvider provider)
{
if (signBit == SignBit.Negative)
return Convert.ToSingle(Int16.Parse(hexString, NumberStyles.HexNumber));
else
return Convert.ToSingle(UInt16.Parse(hexString, NumberStyles.HexNumber));
}
public string ToString(IFormatProvider provider)
{
return "0x" + this.hexString;
}
public object ToType(Type conversionType, IFormatProvider provider)
{
switch (Type.GetTypeCode(conversionType))
{
case TypeCode.Boolean:
return this.ToBoolean(null);
case TypeCode.Byte:
return this.ToByte(null);
case TypeCode.Char:
return this.ToChar(null);
case TypeCode.DateTime:
return this.ToDateTime(null);
case TypeCode.Decimal:
return this.ToDecimal(null);
case TypeCode.Double:
return this.ToDouble(null);
case TypeCode.Int16:
return this.ToInt16(null);
case TypeCode.Int32:
return this.ToInt32(null);
case TypeCode.Int64:
return this.ToInt64(null);
case TypeCode.Object:
if (typeof(HexString).Equals(conversionType))
return this;
else
throw new InvalidCastException(String.Format("Conversion to a {0} is not supported.", conversionType.Name));
case TypeCode.SByte:
return this.ToSByte(null);
case TypeCode.Single:
return this.ToSingle(null);
case TypeCode.String:
return this.ToString(null);
case TypeCode.UInt16:
return this.ToUInt16(null);
case TypeCode.UInt32:
return this.ToUInt32(null);
case TypeCode.UInt64:
return this.ToUInt64(null);
default:
throw new InvalidCastException(String.Format("Conversion to {0} is not supported.", conversionType.Name));
}
}
public UInt16 ToUInt16(IFormatProvider provider)
{
if (signBit == SignBit.Negative)
throw new OverflowException(String.Format("{0} is outside the range of the UInt16 type.",
Int16.Parse(hexString, NumberStyles.HexNumber)));
else
return UInt16.Parse(hexString, NumberStyles.HexNumber);
}
public UInt32 ToUInt32(IFormatProvider provider)
{
if (signBit == SignBit.Negative)
throw new OverflowException(String.Format("{0} is outside the range of the UInt32 type.",
Int16.Parse(hexString, NumberStyles.HexNumber)));
else
return Convert.ToUInt32(hexString, 16);
}
public UInt64 ToUInt64(IFormatProvider provider)
{
if (signBit == SignBit.Negative)
throw new OverflowException(String.Format("{0} is outside the range of the UInt64 type.",
Int64.Parse(hexString, NumberStyles.HexNumber)));
else
return Convert.ToUInt64(hexString, 16);
}
}
open System
open System.Globalization
open System.Text.RegularExpressions
type SignBit =
| Negative = -1
| Zero = 0
| Positive = 1
[<Struct>]
type HexString =
val mutable private hexString: string
val mutable Sign: SignBit
member this.Value
with get () = this.hexString
and set (value: string) =
if value.Trim().Length > 4 then
invalidArg "value" "The string representation of a 16 bit integer cannot have more than four characters."
elif Regex.IsMatch(value, "([0-9,A-F]){1,4}", RegexOptions.IgnoreCase) |> not then
invalidArg "value" "The hexadecimal representation of a 16-bit integer contains invalid characters."
else
this.hexString <- value
interface IConvertible with
// IConvertible implementations.
member _.GetTypeCode() =
TypeCode.Object
member this.ToBoolean(provider: IFormatProvider) =
this.Sign <> SignBit.Zero
member this.ToByte(provider: IFormatProvider) =
if this.Sign = SignBit.Negative then
raise (OverflowException $"{Convert.ToInt16(this.hexString, 16)} is out of range of the Byte type.")
else
try
Convert.ToByte(UInt16.Parse(this.hexString, NumberStyles.HexNumber))
with :? OverflowException as e ->
raise (OverflowException($"{Convert.ToUInt16(this.hexString, 16)} is out of range of the UInt16 type.", e) )
member this.ToChar(provider: IFormatProvider) =
if this.Sign = SignBit.Negative then
raise (OverflowException $"{Convert.ToInt16(this.hexString, 16)} is out of range of the Char type.")
let codePoint = UInt16.Parse(this.hexString, NumberStyles.HexNumber)
Convert.ToChar codePoint
member _.ToDateTime(provider: IFormatProvider) =
raise (InvalidCastException "Hexadecimal to DateTime conversion is not supported.")
member this.ToDecimal(provider: IFormatProvider) =
if this.Sign = SignBit.Negative then
let hexValue = Int16.Parse(this.hexString, NumberStyles.HexNumber)
Convert.ToDecimal hexValue
else
let hexValue = UInt16.Parse(this.hexString, NumberStyles.HexNumber)
Convert.ToDecimal hexValue
member this.ToDouble(provider: IFormatProvider) =
if this.Sign = SignBit.Negative then
Convert.ToDouble(Int16.Parse(this.hexString, NumberStyles.HexNumber))
else
Convert.ToDouble(UInt16.Parse(this.hexString, NumberStyles.HexNumber))
member this.ToInt16(provider: IFormatProvider) =
if this.Sign = SignBit.Negative then
Int16.Parse(this.hexString, NumberStyles.HexNumber)
else
try
Convert.ToInt16(UInt16.Parse(this.hexString, NumberStyles.HexNumber))
with :? OverflowException as e ->
raise (OverflowException($"{Convert.ToUInt16(this.hexString, 16)} is out of range of the Int16 type.", e) )
member this.ToInt32(provider: IFormatProvider) =
if this.Sign = SignBit.Negative then
Convert.ToInt32(Int16.Parse(this.hexString, NumberStyles.HexNumber))
else
Convert.ToInt32(UInt16.Parse(this.hexString, NumberStyles.HexNumber))
member this.ToInt64(provider: IFormatProvider) =
if this.Sign = SignBit.Negative then
Convert.ToInt64(Int16.Parse(this.hexString, NumberStyles.HexNumber))
else
Int64.Parse(this.hexString, NumberStyles.HexNumber)
member this.ToSByte(provider: IFormatProvider) =
if this.Sign = SignBit.Negative then
try
Convert.ToSByte(Int16.Parse(this.hexString, NumberStyles.HexNumber))
with :? OverflowException as e ->
raise (OverflowException($"{Int16.Parse(this.hexString, NumberStyles.HexNumber)} is outside the range of the SByte type.", e))
else
try
Convert.ToSByte(UInt16.Parse(this.hexString, NumberStyles.HexNumber))
with :? OverflowException as e ->
raise (OverflowException($"{UInt16.Parse(this.hexString, NumberStyles.HexNumber)} is outside the range of the SByte type.", e) )
member this.ToSingle(provider: IFormatProvider) =
if this.Sign = SignBit.Negative then
Convert.ToSingle(Int16.Parse(this.hexString, NumberStyles.HexNumber))
else
Convert.ToSingle(UInt16.Parse(this.hexString, NumberStyles.HexNumber))
member this.ToString(provider: IFormatProvider) =
"0x" + this.hexString
member this.ToType(conversionType: Type, provider: IFormatProvider) =
let this = this :> IConvertible
match Type.GetTypeCode conversionType with
| TypeCode.Boolean ->
this.ToBoolean null
| TypeCode.Byte ->
this.ToByte null
| TypeCode.Char ->
this.ToChar null
| TypeCode.DateTime ->
this.ToDateTime null
| TypeCode.Decimal->
this.ToDecimal null
| TypeCode.Double ->
this.ToDouble null
| TypeCode.Int16 ->
this.ToInt16 null
| TypeCode.Int32 ->
this.ToInt32 null
| TypeCode.Int64 ->
this.ToInt64 null
| TypeCode.Object ->
if typeof<HexString>.Equals conversionType then
this
else
raise (InvalidCastException $"Conversion to a {conversionType.Name} is not supported.")
| TypeCode.SByte ->
this.ToSByte null
| TypeCode.Single ->
this.ToSingle null
| TypeCode.String ->
this.ToString null
| TypeCode.UInt16 ->
this.ToUInt16 null
| TypeCode.UInt32 ->
this.ToUInt32 null
| TypeCode.UInt64 ->
this.ToUInt64 null
| _ ->
raise (InvalidCastException $"Conversion to {conversionType.Name} is not supported.")
member this.ToUInt16(provider: IFormatProvider) =
if this.Sign = SignBit.Negative then
raise (OverflowException $"{Int16.Parse(this.hexString, NumberStyles.HexNumber)} is outside the range of the UInt16 type.")
else
UInt16.Parse(this.hexString, NumberStyles.HexNumber)
member this.ToUInt32(provider: IFormatProvider) =
if this.Sign = SignBit.Negative then
raise (OverflowException $"{Int16.Parse(this.hexString, NumberStyles.HexNumber)} is outside the range of the UInt32 type.")
else
Convert.ToUInt32(this.hexString, 16)
member this.ToUInt64(provider: IFormatProvider) =
if this.Sign = SignBit.Negative then
raise (OverflowException $"{Int64.Parse(this.hexString, NumberStyles.HexNumber)} is outside the range of the UInt64 type.")
else
Convert.ToUInt64(this.hexString, 16)
Imports System.Globalization
Imports System.Text.RegularExpressions
Public Enum SignBit As Integer
Positive = 1
Zero = 0
Negative = -1
End Enum
Public Structure HexString : Implements IConvertible
Private signBit As SignBit
Private hexString As String
Public Property Sign As SignBit
Set
signBit = value
End Set
Get
Return signBit
End Get
End Property
Public Property Value As String
Set
If value.Trim().Length > 4 Then
Throw New ArgumentException("The string representation of a 16-bit integer cannot have more than four characters.")
Else If Not Regex.IsMatch(value, "([0-9,A-F]){1,4}", RegexOptions.IgnoreCase) Then
Throw New ArgumentException("The hexadecimal representation of a 16-bit integer contains invalid characters.")
Else
hexString = value
End If
End Set
Get
Return hexString
End Get
End Property
' IConvertible implementations.
Public Function GetTypeCode() As TypeCode _
Implements IConvertible.GetTypeCode
Return TypeCode.Object
End Function
Public Function ToBoolean(provider As IFormatProvider) As Boolean _
Implements IConvertible.ToBoolean
Return signBit <> SignBit.Zero
End Function
Public Function ToByte(provider As IFormatProvider) As Byte _
Implements IConvertible.ToByte
If signBit = signBit.Negative Then
Throw New OverflowException(String.Format("{0} is out of range of the Byte type.", Convert.ToInt16(hexString, 16)))
Else
Try
Return Convert.ToByte(Int16.Parse(hexString, NumberStyles.HexNumber))
Catch e As OverflowException
Throw New OverflowException(String.Format("{0} is out of range of the UInt16 type.", Convert.ToUInt16(hexString, 16)), e)
End Try
End If
End Function
Public Function ToChar(provider As IFormatProvider) As Char _
Implements IConvertible.ToChar
If signBit = signBit.Negative Then
Throw New OverflowException(String.Format("{0} is out of range of the Char type.", Convert.ToInt16(hexString, 16)))
End If
Dim codePoint As UInt16 = UInt16.Parse(Me.hexString, NumberStyles.HexNumber)
Return Convert.ToChar(codePoint)
End Function
Public Function ToDateTime(provider As IFormatProvider) As Date _
Implements IConvertible.ToDateTime
Throw New InvalidCastException("Hexadecimal to DateTime conversion is not supported.")
End Function
Public Function ToDecimal(provider As IFormatProvider) As Decimal _
Implements IConvertible.ToDecimal
If signBit = signBit.Negative Then
Dim hexValue As Short = Int16.Parse(hexString, NumberStyles.HexNumber)
Return Convert.ToDecimal(hexValue)
Else
Dim hexValue As UShort = UInt16.Parse(hexString, NumberStyles.HexNumber)
Return Convert.ToDecimal(hexValue)
End If
End Function
Public Function ToDouble(provider As IFormatProvider) As Double _
Implements IConvertible.ToDouble
If signBit = signBit.Negative Then
Return Convert.ToDouble(Int16.Parse(hexString, NumberStyles.HexNumber))
Else
Return Convert.ToDouble(UInt16.Parse(hexString, NumberStyles.HexNumber))
End If
End Function
Public Function ToInt16(provider As IFormatProvider) As Int16 _
Implements IConvertible.ToInt16
If signBit = SignBit.Negative Then
Return Int16.Parse(hexString, NumberStyles.HexNumber)
Else
Try
Return Convert.ToInt16(UInt16.Parse(hexString, NumberStyles.HexNumber))
Catch e As OverflowException
Throw New OverflowException(String.Format("{0} is out of range of the Int16 type.", Convert.ToUInt16(hexString, 16)), e)
End Try
End If
End Function
Public Function ToInt32(provider As IFormatProvider) As Int32 _
Implements IConvertible.ToInt32
If signBit = SignBit.Negative Then
Return Convert.ToInt32(Int16.Parse(hexString, NumberStyles.HexNumber))
Else
Return Convert.ToInt32(UInt16.Parse(hexString, NumberStyles.HexNumber))
End If
End Function
Public Function ToInt64(provider As IFormatProvider) As Int64 _
Implements IConvertible.ToInt64
If signBit = signBit.Negative Then
Return Convert.ToInt64(Int16.Parse(hexString, NumberStyles.HexNumber))
Else
Return Int64.Parse(hexString, NumberStyles.HexNumber)
End If
End Function
Public Function ToSByte(provider As IFormatProvider) As SByte _
Implements IConvertible.ToSByte
If signBit = signBit.Negative Then
Try
Return Convert.ToSByte(Int16.Parse(hexString, NumberStyles.HexNumber))
Catch e As OverflowException
Throw New OverflowException(String.Format("{0} is outside the range of the SByte type.", _
Int16.Parse(hexString, NumberStyles.HexNumber), e))
End Try
Else
Try
Return Convert.ToSByte(UInt16.Parse(hexString, NumberStyles.HexNumber))
Catch e As OverflowException
Throw New OverflowException(String.Format("{0} is outside the range of the SByte type.", _
UInt16.Parse(hexString, NumberStyles.HexNumber)), e)
End Try
End If
End Function
Public Function ToSingle(provider As IFormatProvider) As Single _
Implements IConvertible.ToSingle
If signBit = signBit.Negative Then
Return Convert.ToSingle(Int16.Parse(hexString, NumberStyles.HexNumber))
Else
Return Convert.ToSingle(UInt16.Parse(hexString, NumberStyles.HexNumber))
End If
End Function
Public Overloads Function ToString(provider As IFormatProvider) As String _
Implements IConvertible.ToString
Return "0x" & Me.hexString
End Function
Public Function ToType(conversionType As Type, provider As IFormatProvider) As Object _
Implements IConvertible.ToType
Select Case Type.GetTypeCode(conversionType)
Case TypeCode.Boolean
Return Me.ToBoolean(Nothing)
Case TypeCode.Byte
Return Me.ToByte(Nothing)
Case TypeCode.Char
Return Me.ToChar(Nothing)
Case TypeCode.DateTime
Return Me.ToDateTime(Nothing)
Case TypeCode.Decimal
Return Me.ToDecimal(Nothing)
Case TypeCode.Double
Return Me.ToDouble(Nothing)
Case TypeCode.Int16
Return Me.ToInt16(Nothing)
Case TypeCode.Int32
Return Me.ToInt32(Nothing)
Case TypeCode.Int64
Return Me.ToInt64(Nothing)
Case TypeCode.Object
If GetType(HexString).Equals(conversionType) Then
Return Me
Else
Throw New InvalidCastException(String.Format("Conversion to a {0} is not supported.", conversionType.Name))
End If
Case TypeCode.SByte
Return Me.ToSByte(Nothing)
Case TypeCode.Single
Return Me.ToSingle(Nothing)
Case TypeCode.String
Return Me.ToString(Nothing)
Case TypeCode.UInt16
Return Me.ToUInt16(Nothing)
Case TypeCode.UInt32
Return Me.ToUInt32(Nothing)
Case TypeCode.UInt64
Return Me.ToUInt64(Nothing)
Case Else
Throw New InvalidCastException(String.Format("Conversion to {0} is not supported.", conversionType.Name))
End Select
End Function
Public Function ToUInt16(provider As IFormatProvider) As UInt16 _
Implements IConvertible.ToUInt16
If signBit = signBit.Negative Then
Throw New OverflowException(String.Format("{0} is outside the range of the UInt16 type.", _
Int16.Parse(hexString, NumberStyles.HexNumber)))
Else
Return Convert.ToUInt16(hexString, 16)
End If
End Function
Public Function ToUInt32(provider As IFormatProvider) As UInt32 _
Implements IConvertible.ToUInt32
If signBit = signBit.Negative Then
Throw New OverflowException(String.Format("{0} is outside the range of the UInt32 type.", _
Int16.Parse(hexString, NumberStyles.HexNumber)))
Else
Return Convert.ToUInt32(hexString, 16)
End If
End Function
Public Function ToUInt64(provider As IFormatProvider) As UInt64 _
Implements IConvertible.ToUInt64
If signBit = signBit.Negative Then
Throw New OverflowException(String.Format("{0} is outside the range of the UInt64 type.", _
Int16.Parse(hexString, NumberStyles.HexNumber)))
Else
Return Convert.ToUInt64(hexString, 16)
End If
End Function
End Structure
The following example shows that a call to the ToUInt16(Object, IFormatProvider) method that passes a HexString
object as a parameter, in turn, calls the IConvertible.ToUInt16 implementation of the HexString
class.
public class Example
{
public static void Main()
{
ushort positiveValue = 32000;
short negativeValue = -1;
HexString positiveString = new HexString();
positiveString.Sign = (SignBit) Math.Sign(positiveValue);
positiveString.Value = positiveValue.ToString("X2");
HexString negativeString = new HexString();
negativeString.Sign = (SignBit) Math.Sign(negativeValue);
negativeString.Value = negativeValue.ToString("X2");
try {
Console.WriteLine("0x{0} converts to {1}.", positiveString.Value, Convert.ToUInt16(positiveString));
}
catch (OverflowException) {
Console.WriteLine("{0} is outside the range of the UInt16 type.",
Int16.Parse(negativeString.Value, NumberStyles.HexNumber));
}
try {
Console.WriteLine("0x{0} converts to {1}.", negativeString.Value, Convert.ToUInt16(negativeString));
}
catch (OverflowException) {
Console.WriteLine("{0} is outside the range of the UInt16 type.",
Int16.Parse(negativeString.Value, NumberStyles.HexNumber));
}
}
}
// The example displays the following output:
// 0x7D00 converts to 32000.
// -1 is outside the range of the UInt16 type.
let positiveValue = 32000us
let negativeValue = -1s
let mutable positiveString = HexString()
positiveString.Sign <- Math.Sign positiveValue |> enum
positiveString.Value <- positiveValue.ToString "X2"
let mutable negativeString = HexString()
negativeString.Sign <- sign negativeValue |> enum
negativeString.Value <- negativeValue.ToString "X2"
try
printfn $"0x{positiveString.Value} converts to {Convert.ToUInt16 positiveString}."
with :? OverflowException ->
printfn $"{Int16.Parse(negativeString.Value, NumberStyles.HexNumber)} is outside the range of the UInt16 type."
try
printfn $"0x{negativeString.Value} converts to {Convert.ToUInt16 negativeString}."
with :? OverflowException ->
printfn $"{Int16.Parse(negativeString.Value, NumberStyles.HexNumber)} is outside the range of the UInt16 type."
// The example displays the following output:
// 0x7D00 converts to 32000.
// -1 is outside the range of the UInt16 type.
Module Example
Public Sub Main()
Dim positiveValue As UInt16 = 32000
Dim negativeValue As Int16 = -1
Dim positiveString As New HexString()
positiveString.Sign = CType(Math.Sign(positiveValue), SignBit)
positiveString.Value = positiveValue.ToString("X4")
Dim negativeString As New HexString()
negativeString.Sign = CType(Math.Sign(negativeValue), SignBit)
negativeString.Value = negativeValue.ToString("X4")
Try
Console.WriteLine("0x{0} converts to {1}.", positiveString.Value, Convert.ToUInt16(positiveString))
Catch e As OverflowException
Console.WriteLine("{0} is outside the range of the UInt16 type.", _
Int16.Parse(positiveString.Value, NumberStyles.HexNumber))
End Try
Try
Console.WriteLine("0x{0} converts to {1}.", negativeString.Value, Convert.ToUInt16(negativeString))
Catch e As OverflowException
Console.WriteLine("{0} is outside the range of the UInt16 type.", _
Int16.Parse(negativeString.Value, NumberStyles.HexNumber))
End Try
End Sub
End Module
' The example dosplays the following output:
' 0x7D00 converts to 32000.
' -1 is outside the range of the UInt16 type.
Remarks
The return value is the result of invoking the IConvertible.ToUInt16 method of the underlying type of value
.
provider
enables the user to specify culture-specific conversion information about the contents of value
. For example, if value
is a String that represents a number, provider
could supply culture-specific information about the notation used to represent that number.
The base types ignore provider
; however, the parameter may be used if value
is a user-defined type that implements the IConvertible interface.
Applies to
.NET 9 and other versions
Product | Versions |
---|---|
.NET | Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9 |
.NET Framework | 1.1, 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1 |
.NET Standard | 1.0, 1.1, 1.2, 1.3, 1.4, 1.5, 1.6, 2.0, 2.1 |
UWP | 10.0 |
- Source:
- Convert.cs
- Source:
- Convert.cs
- Source:
- Convert.cs
Important
This API is not CLS-compliant.
Converts the specified string representation of a number to an equivalent 16-bit unsigned integer, using the specified culture-specific formatting information.
public:
static System::UInt16 ToUInt16(System::String ^ value, IFormatProvider ^ provider);
[System.CLSCompliant(false)]
public static ushort ToUInt16 (string value, IFormatProvider provider);
[System.CLSCompliant(false)]
public static ushort ToUInt16 (string? value, IFormatProvider? provider);
[<System.CLSCompliant(false)>]
static member ToUInt16 : string * IFormatProvider -> uint16
Public Shared Function ToUInt16 (value As String, provider As IFormatProvider) As UShort
Parameters
- value
- String
A string that contains the number to convert.
- provider
- IFormatProvider
An object that supplies culture-specific formatting information.
Returns
A 16-bit unsigned integer that is equivalent to the number in value
, or 0 (zero) if value
is null
.
- Attributes
Exceptions
value
does not consist of an optional sign followed by a sequence of digits (0 through 9).
value
represents a number that is less than UInt16.MinValue or greater than UInt16.MaxValue.
Examples
The following example defines a custom NumberFormatInfo object that recognizes the string "pos" as the positive sign and the string "neg" as the negative sign. It then attempts to convert each element of a numeric string array to an integer using both this provider and the NumberFormatInfo provider for the invariant culture.
using System;
using System.Globalization;
public class Example
{
public static void Main()
{
// Create a NumberFormatInfo object and set several of its
// properties that apply to numbers.
NumberFormatInfo provider = new NumberFormatInfo();
provider.PositiveSign = "pos ";
provider.NegativeSign = "neg ";
// Define an array of strings to convert to UInt16 values.
string[] values= { "34567", "+34567", "pos 34567", "34567.",
"34567.", "65535", "65535", "65535" };
foreach (string value in values)
{
Console.Write("{0,-12:} --> ", value);
try {
Console.WriteLine("{0,17}", Convert.ToUInt16(value, provider));
}
catch (FormatException e) {
Console.WriteLine("{0,17}", e.GetType().Name);
}
}
}
}
// The example displays the following output:
// 34567 --> 34567
// +34567 --> FormatException
// pos 34567 --> 34567
// 34567. --> FormatException
// 34567. --> FormatException
// 65535 --> 65535
// 65535 --> 65535
// 65535 --> 65535
open System
open System.Globalization
// Create a NumberFormatInfo object and set several of its
// properties that apply to numbers.
let provider = NumberFormatInfo()
provider.PositiveSign <- "pos "
provider.NegativeSign <- "neg "
// Define an array of strings to convert to UInt16 values.
let values =
[| "34567"; "+34567"; "pos 34567"; "34567."
"34567."; "65535"; "65535"; "65535" |]
for value in values do
printf $"{value,-12} --> "
try
printfn $"{Convert.ToUInt16(value, provider),17}"
with :? FormatException as e ->
printfn $"{e.GetType().Name,17}"
// The example displays the following output:
// 34567 --> 34567
// +34567 --> FormatException
// pos 34567 --> 34567
// 34567. --> FormatException
// 34567. --> FormatException
// 65535 --> 65535
// 65535 --> 65535
// 65535 --> 65535
Imports System.Globalization
Module Example
Public Sub Main()
' Create a NumberFormatInfo object and set several of its
' properties that apply to numbers.
Dim provider As New NumberFormatInfo()
provider.PositiveSign = "pos "
provider.NegativeSign = "neg "
' Define an array of strings to convert to UInt16 values.
Dim values() As String = { "34567", "+34567", "pos 34567", _
"34567.", "34567.", "65535", _
"65535", "65535" }
For Each value As String In values
Console.Write("{0,-12:} --> ", value)
Try
Console.WriteLine("{0,17}", Convert.ToUInt16(value, provider))
Catch e As FormatException
Console.WriteLine("{0,17}", e.GetType().Name)
End Try
Next
End Sub
End Module
' The example displays the following output:
' 34567 --> 34567
' +34567 --> FormatException
' pos 34567 --> 34567
' 34567. --> FormatException
' 34567. --> FormatException
' 65535 --> 65535
' 65535 --> 65535
' 65535 --> 65535
Remarks
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.
Applies to
.NET 9 and other versions
Product | Versions |
---|---|
.NET | Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9 |
.NET Framework | 1.1, 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1 |
.NET Standard | 1.0, 1.1, 1.2, 1.3, 1.4, 1.5, 1.6, 2.0, 2.1 |
UWP | 10.0 |
- Source:
- Convert.cs
- Source:
- Convert.cs
- Source:
- Convert.cs
Important
This API is not CLS-compliant.
Converts the value of the specified single-precision floating-point number to an equivalent 16-bit unsigned integer.
public:
static System::UInt16 ToUInt16(float value);
[System.CLSCompliant(false)]
public static ushort ToUInt16 (float value);
[<System.CLSCompliant(false)>]
static member ToUInt16 : single -> uint16
Public Shared Function ToUInt16 (value As Single) As UShort
Parameters
- value
- Single
The single-precision floating-point number to convert.
Returns
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.
- Attributes
Exceptions
value
is less than zero or greater than UInt16.MaxValue.
Examples
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.
let numbers =
[| Single.MinValue; -1.38e10f; -1023.299f; -12.98f
0f; 9.113e-16f; 103.919f; 17834.191f; Single.MaxValue |]
for number in numbers do
try
let result = Convert.ToUInt16 number
printfn $"Converted the {number.GetType().Name} value '{number}' to the {result.GetType().Name} value {result}."
with :? OverflowException ->
printfn $"{number} is outside the range of the UInt16 type."
// 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.
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.
See also
Applies to
.NET 9 and other versions
Product | Versions |
---|---|
.NET | Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9 |
.NET Framework | 1.1, 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1 |
.NET Standard | 1.0, 1.1, 1.2, 1.3, 1.4, 1.5, 1.6, 2.0, 2.1 |
UWP | 10.0 |
- Source:
- Convert.cs
- Source:
- Convert.cs
- Source:
- Convert.cs
Important
This API is not CLS-compliant.
Converts the value of the specified 64-bit unsigned integer to an equivalent 16-bit unsigned integer.
public:
static System::UInt16 ToUInt16(System::UInt64 value);
[System.CLSCompliant(false)]
public static ushort ToUInt16 (ulong value);
[<System.CLSCompliant(false)>]
static member ToUInt16 : uint64 -> uint16
Public Shared Function ToUInt16 (value As ULong) As UShort
Parameters
- value
- UInt64
The 64-bit unsigned integer to convert.
Returns
A 16-bit unsigned integer that is equivalent to value
.
- Attributes
Exceptions
value
is greater than UInt16.MaxValue.
Examples
The following example attempts to convert each element in an array of unsigned long integers to an unsigned 16-bit integer.
ulong[] numbers = { UInt64.MinValue, 121, 340, UInt64.MaxValue };
ushort result;
foreach (ulong 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("The {0} value {1} is outside the range of the UInt16 type.",
number.GetType().Name, number);
}
}
// The example displays the following output:
// Converted the UInt64 value '0' to the UInt16 value 0.
// Converted the UInt64 value '121' to the UInt16 value 121.
// Converted the UInt64 value '340' to the UInt16 value 340.
// The UInt64 value 18446744073709551615 is outside the range of the UInt16 type.
let numbers = [| UInt64.MinValue; 121uL; 340uL; UInt64.MaxValue |]
for number in numbers do
try
let result = Convert.ToUInt16 number
printfn $"Converted the {number.GetType().Name} value '{number}' to the {result.GetType().Name} value {result}."
with :? OverflowException ->
printfn $"The {number.GetType().Name} value {number} is outside the range of the UInt16 type."
// The example displays the following output:
// Converted the UInt64 value '0' to the UInt16 value 0.
// Converted the UInt64 value '121' to the UInt16 value 121.
// Converted the UInt64 value '340' to the UInt16 value 340.
// The UInt64 value 18446744073709551615 is outside the range of the UInt16 type.
Dim numbers() As ULong = { UInt64.MinValue, 121, 340, UInt64.MaxValue }
Dim result As UShort
For Each number As ULong 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 e As OverflowException
Console.WriteLine("The {0} value {1} is outside the range of the UInt16 type.", _
number.GetType().Name, number)
End Try
Next
' The example displays the following output:
' Converted the UInt64 value '0' to the UInt16 value 0.
' Converted the UInt64 value '121' to the UInt16 value 121.
' Converted the UInt64 value '340' to the UInt16 value 340.
' The UInt64 value 18446744073709551615 is outside the range of the UInt16 type.
Applies to
.NET 9 and other versions
Product | Versions |
---|---|
.NET | Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9 |
.NET Framework | 1.1, 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1 |
.NET Standard | 1.0, 1.1, 1.2, 1.3, 1.4, 1.5, 1.6, 2.0, 2.1 |
UWP | 10.0 |
- Source:
- Convert.cs
- Source:
- Convert.cs
- Source:
- Convert.cs
Important
This API is not CLS-compliant.
Converts the value of the specified 8-bit signed integer to the equivalent 16-bit unsigned integer.
public:
static System::UInt16 ToUInt16(System::SByte value);
[System.CLSCompliant(false)]
public static ushort ToUInt16 (sbyte value);
[<System.CLSCompliant(false)>]
static member ToUInt16 : sbyte -> uint16
Public Shared Function ToUInt16 (value As SByte) As UShort
Parameters
- value
- SByte
The 8-bit signed integer to convert.
Returns
A 16-bit unsigned integer that is equivalent to value
.
- Attributes
Exceptions
value
is less than zero.
Examples
The following example converts each element in a signed byte array to an unsigned 16-bit integer.
sbyte[] numbers = { SByte.MinValue, -1, 0, 10, SByte.MaxValue };
ushort result;
foreach (sbyte 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:
// -128 is outside the range of the UInt16 type.
// -1 is outside the range of the UInt16 type.
// Converted the SByte value '0' to the UInt16 value 0.
// Converted the SByte value '10' to the UInt16 value 10.
// Converted the SByte value '127' to the UInt16 value 127.
let numbers = [| SByte.MinValue; -1y; 0y; 10y; SByte.MaxValue |]
for number in numbers do
try
let result = Convert.ToUInt16 number
printfn $"Converted the {number.GetType().Name} value '{number}' to the {result.GetType().Name} value {result}."
with :? OverflowException ->
printfn $"{number} is outside the range of the UInt16 type."
// The example displays the following output:
// -128 is outside the range of the UInt16 type.
// -1 is outside the range of the UInt16 type.
// Converted the SByte value '0' to the UInt16 value 0.
// Converted the SByte value '10' to the UInt16 value 10.
// Converted the SByte value '127' to the UInt16 value 127.
Dim numbers() As SByte = { SByte.MinValue, -1, 0, 10, SByte.MaxValue }
Dim result As UShort
For Each number As SByte 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 e As OverflowException
Console.WriteLine("{0} is outside the range of the UInt16 type.", number)
End Try
Next
' The example displays the following output:
' -128 is outside the range of the UInt16 type.
' -1 is outside the range of the UInt16 type.
' Converted the SByte value '0' to the UInt16 value 0.
' Converted the SByte value '10' to the UInt16 value 10.
' Converted the SByte value '127' to the UInt16 value 127.
Applies to
.NET 9 and other versions
Product | Versions |
---|---|
.NET | Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9 |
.NET Framework | 1.1, 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1 |
.NET Standard | 1.0, 1.1, 1.2, 1.3, 1.4, 1.5, 1.6, 2.0, 2.1 |
UWP | 10.0 |
- Source:
- Convert.cs
- Source:
- Convert.cs
- Source:
- Convert.cs
Important
This API is not CLS-compliant.
Converts the value of the specified Unicode character to the equivalent 16-bit unsigned integer.
public:
static System::UInt16 ToUInt16(char value);
[System.CLSCompliant(false)]
public static ushort ToUInt16 (char value);
[<System.CLSCompliant(false)>]
static member ToUInt16 : char -> uint16
Public Shared Function ToUInt16 (value As Char) As UShort
Parameters
- value
- Char
The Unicode character to convert.
Returns
The 16-bit unsigned integer equivalent to value
.
- Attributes
Examples
The following example converts each element in a character array to an unsigned 16-bit integer.
char[] chars = { 'a', 'z', '\x0007', '\x03FF',
'\x7FFF', '\xFFFE' };
ushort result;
foreach (char ch in chars)
{
try {
result = Convert.ToUInt16(ch);
Console.WriteLine("Converted the {0} value '{1}' to the {2} value {3}.",
ch.GetType().Name, ch,
result.GetType().Name, result);
}
catch (OverflowException) {
Console.WriteLine("Unable to convert u+{0} to a UInt16.",
((int)ch).ToString("X4"));
}
}
// The example displays the following output:
// Converted the Char value 'a' to the UInt16 value 97.
// Converted the Char value 'z' to the UInt16 value 122.
// Converted the Char value '' to the UInt16 value 7.
// Converted the Char value '?' to the UInt16 value 1023.
// Converted the Char value '?' to the UInt16 value 32767.
// Converted the Char value '?' to the UInt16 value 65534.
let chars =
[| 'a'; 'z'; '\u0007'; '\u03FF'; '\u7FFF'; '\uFFFE' |]
for ch in chars do
try
let result = Convert.ToUInt16 ch
printfn $"Converted the {ch.GetType().Name} value '{ch}' to the {result.GetType().Name} value {result}."
with :? OverflowException ->
printfn $"Unable to convert u+{int ch:X4} to a UInt16."
// The example displays the following output:
// Converted the Char value 'a' to the UInt16 value 97.
// Converted the Char value 'z' to the UInt16 value 122.
// Converted the Char value '' to the UInt16 value 7.
// Converted the Char value '?' to the UInt16 value 1023.
// Converted the Char value '?' to the UInt16 value 32767.
// Converted the Char value '?' to the UInt16 value 65534.
Dim chars() As Char = { "a"c, "z"c, ChrW(7), ChrW(1023), _
ChrW(Short.MaxValue), ChrW(&hFFFE) }
Dim result As UShort
For Each ch As Char in chars
result = Convert.ToUInt16(ch)
Console.WriteLine("Converted the {0} value '{1}' to the {2} value {3}.", _
ch.GetType().Name, ch, _
result.GetType().Name, result)
Next
' The example displays the following output:
' Converted the Char value 'a' to the UInt16 value 97.
' Converted the Char value 'z' to the UInt16 value 122.
' Converted the Char value '' to the UInt16 value 7.
' Converted the Char value '?' to the UInt16 value 1023.
' Converted the Char value '?' to the UInt16 value 32767.
' Converted the Char value '?' to the UInt16 value 65534.
Applies to
.NET 9 and other versions
Product | Versions |
---|---|
.NET | Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9 |
.NET Framework | 1.1, 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1 |
.NET Standard | 1.0, 1.1, 1.2, 1.3, 1.4, 1.5, 1.6, 2.0, 2.1 |
UWP | 10.0 |
- Source:
- Convert.cs
- Source:
- Convert.cs
- Source:
- Convert.cs
Important
This API is not CLS-compliant.
Converts the value of the specified 64-bit signed integer to an equivalent 16-bit unsigned integer.
public:
static System::UInt16 ToUInt16(long value);
[System.CLSCompliant(false)]
public static ushort ToUInt16 (long value);
[<System.CLSCompliant(false)>]
static member ToUInt16 : int64 -> uint16
Public Shared Function ToUInt16 (value As Long) As UShort
Parameters
- value
- Int64
The 64-bit signed integer to convert.
Returns
A 16-bit unsigned integer that is equivalent to value
.
- Attributes
Exceptions
value
is less than zero or greater than UInt16.MaxValue.
Examples
The following example converts each element in a long integer array to an unsigned 16-bit integer.
long[] numbers = { Int64.MinValue, -1, 0, 121, 340, Int64.MaxValue };
ushort result;
foreach (long 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("The {0} value {1} is outside the range of the UInt16 type.",
number.GetType().Name, number);
}
}
// The example displays the following output:
// The Int64 value -9223372036854775808 is outside the range of the UInt16 type.
// The Int64 value -1 is outside the range of the UInt16 type.
// Converted the Int64 value '0' to the UInt16 value 0.
// Converted the Int64 value '121' to the UInt16 value 121.
// Converted the Int64 value '340' to the UInt16 value 340.
// The Int64 value 9223372036854775807 is outside the range of the UInt16 type.
let numbers = [| Int64.MinValue; -1; 0; 121; 340; Int64.MaxValue |]
for number in numbers do
try
let result = Convert.ToUInt16 number
printfn $"Converted the {number.GetType().Name} value '{number}' to the {result.GetType().Name} value {result}."
with :? OverflowException ->
printfn "The {number.GetType().Name} value {number} is outside the range of the UInt16 type."
// The example displays the following output:
// The Int64 value -9223372036854775808 is outside the range of the UInt16 type.
// The Int64 value -1 is outside the range of the UInt16 type.
// Converted the Int64 value '0' to the UInt16 value 0.
// Converted the Int64 value '121' to the UInt16 value 121.
// Converted the Int64 value '340' to the UInt16 value 340.
// The Int64 value 9223372036854775807 is outside the range of the UInt16 type.
Dim numbers() As Long = { Int64.MinValue, -1, 0, 121, 340, Int64.MaxValue }
Dim result As UShort
For Each number As Long 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 e As OverflowException
Console.WriteLine("The {0} value {1} is outside the range of the UInt16 type.", _
number.GetType().Name, number)
End Try
Next
' The example displays the following output:
' The Int64 value -9223372036854775808 is outside the range of the UInt16 type.
' The Int64 value -1 is outside the range of the UInt16 type.
' Converted the Int64 value '0' to the UInt16 value 0.
' Converted the Int64 value '121' to the UInt16 value 121.
' Converted the Int64 value '340' to the UInt16 value 340.
' The Int64 value 9223372036854775807 is outside the range of the UInt16 type.
Applies to
.NET 9 and other versions
Product | Versions |
---|---|
.NET | Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9 |
.NET Framework | 1.1, 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1 |
.NET Standard | 1.0, 1.1, 1.2, 1.3, 1.4, 1.5, 1.6, 2.0, 2.1 |
UWP | 10.0 |
- Source:
- Convert.cs
- Source:
- Convert.cs
- Source:
- Convert.cs
Important
This API is not CLS-compliant.
Converts the value of the specified 32-bit signed integer to an equivalent 16-bit unsigned integer.
public:
static System::UInt16 ToUInt16(int value);
[System.CLSCompliant(false)]
public static ushort ToUInt16 (int value);
[<System.CLSCompliant(false)>]
static member ToUInt16 : int -> uint16
Public Shared Function ToUInt16 (value As Integer) As UShort
Parameters
- value
- Int32
The 32-bit signed integer to convert.
Returns
A 16-bit unsigned integer that is equivalent to value
.
- Attributes
Exceptions
value
is less than zero or greater than UInt16.MaxValue.
Examples
The following example converts each element in an integer array to an unsigned 16-bit integer.
int[] numbers = { Int32.MinValue, -1, 0, 121, 340, Int32.MaxValue };
ushort result;
foreach (int 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("The {0} value {1} is outside the range of the UInt16 type.",
number.GetType().Name, number);
}
}
// The example displays the following output:
// The Int32 value -2147483648 is outside the range of the UInt16 type.
// The Int32 value -1 is outside the range of the UInt16 type.
// Converted the Int32 value '0' to the UInt16 value 0.
// Converted the Int32 value '121' to the UInt16 value 121.
// Converted the Int32 value '340' to the UInt16 value 340.
// The Int32 value 2147483647 is outside the range of the UInt16 type.
let numbers = [| Int32.MinValue; -1; 0; 121; 340; Int32.MaxValue |]
for number in numbers do
try
let result = Convert.ToUInt16 number
printfn $"Converted the {number.GetType().Name} value '{number}' to the {result.GetType().Name} value {result}."
with :? OverflowException ->
printfn "The {number.GetType().Name} value {number} is outside the range of the UInt16 type."
// The example displays the following output:
// The Int32 value -2147483648 is outside the range of the UInt16 type.
// The Int32 value -1 is outside the range of the UInt16 type.
// Converted the Int32 value '0' to the UInt16 value 0.
// Converted the Int32 value '121' to the UInt16 value 121.
// Converted the Int32 value '340' to the UInt16 value 340.
// The Int32 value 2147483647 is outside the range of the UInt16 type.
Dim numbers() As Integer = { Int32.MinValue, -1, 0, 121, 340, Int32.MaxValue }
Dim result As UShort
For Each number As Integer 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 e As OverflowException
Console.WriteLine("The {0} value {1} is outside the range of the UInt16 type.", _
number.GetType().Name, number)
End Try
Next
' The example displays the following output:
' The Int32 value -2147483648 is outside the range of the UInt16 type.
' The Int32 value -1 is outside the range of the UInt16 type.
' Converted the Int32 value '0' to the UInt16 value 0.
' Converted the Int32 value '121' to the UInt16 value 121.
' Converted the Int32 value '340' to the UInt16 value 340.
' The Int32 value 2147483647 is outside the range of the UInt16 type.
Applies to
.NET 9 and other versions
Product | Versions |
---|---|
.NET | Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9 |
.NET Framework | 1.1, 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1 |
.NET Standard | 1.0, 1.1, 1.2, 1.3, 1.4, 1.5, 1.6, 2.0, 2.1 |
UWP | 10.0 |
- Source:
- Convert.cs
- Source:
- Convert.cs
- Source:
- Convert.cs
Important
This API is not CLS-compliant.
Converts the value of the specified 16-bit signed integer to the equivalent 16-bit unsigned integer.
public:
static System::UInt16 ToUInt16(short value);
[System.CLSCompliant(false)]
public static ushort ToUInt16 (short value);
[<System.CLSCompliant(false)>]
static member ToUInt16 : int16 -> uint16
Public Shared Function ToUInt16 (value As Short) As UShort
Parameters
- value
- Int16
The 16-bit signed integer to convert.
Returns
A 16-bit unsigned integer that is equivalent to value
.
- Attributes
Exceptions
value
is less than zero.
Examples
The following example attempts to convert each element in a 16-bit integer array to an unsigned 16-bit integer.
short[] numbers = { Int16.MinValue, -132, 0, 121, 16103, Int16.MaxValue };
ushort result;
foreach (short 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("The {0} value {1} is outside the range of the UInt16 type.",
number.GetType().Name, number);
}
}
// The example displays the following output:
// The Int16 value -32768 is outside the range of the UInt16 type.
// The Int16 value -132 is outside the range of the UInt16 type.
// Converted the Int16 value '0' to the UInt16 value 0.
// Converted the Int16 value '121' to the UInt16 value 121.
// Converted the Int16 value '16103' to the UInt16 value 16103.
// Converted the Int16 value '32767' to the UInt16 value 32767.
let numbers = [| Int16.MinValue; -132s; 0s; 121s; 16103s; Int16.MaxValue |]
for number in numbers do
try
let result = Convert.ToUInt16 number
printfn $"Converted the {number.GetType().Name} value '{number}' to the {result.GetType().Name} value {result}."
with :? OverflowException ->
printfn $"The {number.GetType().Name} value {number} is outside the range of the UInt16 type."
// The example displays the following output:
// The Int16 value -32768 is outside the range of the UInt16 type.
// The Int16 value -132 is outside the range of the UInt16 type.
// Converted the Int16 value '0' to the UInt16 value 0.
// Converted the Int16 value '121' to the UInt16 value 121.
// Converted the Int16 value '16103' to the UInt16 value 16103.
// Converted the Int16 value '32767' to the UInt16 value 32767.
Dim numbers() As Short = { Int16.MinValue, -132, 0, 121, 16103, Int16.MaxValue }
Dim result As UShort
For Each number As Short 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 e As OverflowException
Console.WriteLine("The {0} value {1} is outside the range of the UInt16 type.", _
number.GetType().Name, number)
End Try
Next
' The example displays the following output:
' The Int16 value -32768 is outside the range of the UInt16 type.
' The Int16 value -132 is outside the range of the UInt16 type.
' Converted the Int16 value '0' to the UInt16 value 0.
' Converted the Int16 value '121' to the UInt16 value 121.
' Converted the Int16 value '16103' to the UInt16 value 16103.
' Converted the Int16 value '32767' to the UInt16 value 32767.
Applies to
.NET 9 and other versions
Product | Versions |
---|---|
.NET | Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9 |
.NET Framework | 1.1, 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1 |
.NET Standard | 1.0, 1.1, 1.2, 1.3, 1.4, 1.5, 1.6, 2.0, 2.1 |
UWP | 10.0 |
- Source:
- Convert.cs
- Source:
- Convert.cs
- Source:
- Convert.cs
Important
This API is not CLS-compliant.
Converts the value of the specified decimal number to an equivalent 16-bit unsigned integer.
public:
static System::UInt16 ToUInt16(System::Decimal value);
[System.CLSCompliant(false)]
public static ushort ToUInt16 (decimal value);
[<System.CLSCompliant(false)>]
static member ToUInt16 : decimal -> uint16
Public Shared Function ToUInt16 (value As Decimal) As UShort
Parameters
- value
- Decimal
The decimal number to convert.
Returns
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.
- Attributes
Exceptions
value
is less than zero or greater than UInt16.MaxValue.
Examples
The following example converts each element in an array of Decimal values to an unsigned 16-bit integer.
decimal[] numbers = { Decimal.MinValue, -1034.23m, -12m, 0m, 147m,
9214.16m, Decimal.MaxValue };
ushort result;
foreach (decimal 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:
// -79228162514264337593543950335 is outside the range of the UInt16 type.
// -1034.23 is outside the range of the UInt16 type.
// -12 is outside the range of the UInt16 type.
// Converted the Decimal value '0' to the UInt16 value 0.
// Converted the Decimal value '147' to the UInt16 value 147.
// Converted the Decimal value '9214.16' to the UInt16 value 9214.
// 79228162514264337593543950335 is outside the range of the UInt16 type.
let numbers =
[| Decimal.MinValue; -1034.23m; -12m; 0m; 147m; 9214.16m; Decimal.MaxValue |]
for number in numbers do
try
let result = Convert.ToUInt16 number
printfn $"Converted the {number.GetType().Name} value '{number}' to the {result.GetType().Name} value {result}."
with :? OverflowException ->
printfn $"{number} is outside the range of the UInt16 type."
// The example displays the following output:
// -79228162514264337593543950335 is outside the range of the UInt16 type.
// -1034.23 is outside the range of the UInt16 type.
// -12 is outside the range of the UInt16 type.
// Converted the Decimal value '0' to the UInt16 value 0.
// Converted the Decimal value '147' to the UInt16 value 147.
// Converted the Decimal value '9214.16' to the UInt16 value 9214.
// 79228162514264337593543950335 is outside the range of the UInt16 type.
Dim values() As Decimal = { Decimal.MinValue, -1034.23d, -12d, 0d, 147d, _
9214.16d, Decimal.MaxValue }
Dim result As UShort
For Each value As Decimal 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:
' -79228162514264337593543950335 is outside the range of the UInt16 type.
' -1034.23 is outside the range of the UInt16 type.
' -12 is outside the range of the UInt16 type.
' Converted the Decimal value '0' to the UInt16 value 0.
' Converted the Decimal value '147' to the UInt16 value 147.
' Converted the Decimal value '9214.16' to the UInt16 value 9214.
' 79228162514264337593543950335 is outside the range of the UInt16 type.
See also
Applies to
.NET 9 and other versions
Product | Versions |
---|---|
.NET | Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9 |
.NET Framework | 1.1, 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1 |
.NET Standard | 1.0, 1.1, 1.2, 1.3, 1.4, 1.5, 1.6, 2.0, 2.1 |
UWP | 10.0 |
- Source:
- Convert.cs
- Source:
- Convert.cs
- Source:
- Convert.cs
Important
This API is not CLS-compliant.
Calling this method always throws InvalidCastException.
public:
static System::UInt16 ToUInt16(DateTime value);
[System.CLSCompliant(false)]
public static ushort ToUInt16 (DateTime value);
[<System.CLSCompliant(false)>]
static member ToUInt16 : DateTime -> uint16
Public Shared Function ToUInt16 (value As DateTime) As UShort
Parameters
- value
- DateTime
The date and time value to convert.
Returns
This conversion is not supported. No value is returned.
- Attributes
Exceptions
This conversion is not supported.
Applies to
.NET 9 and other versions
Product | Versions |
---|---|
.NET | Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9 |
.NET Framework | 1.1, 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1 |
.NET Standard | 2.0, 2.1 |
- Source:
- Convert.cs
- Source:
- Convert.cs
- Source:
- Convert.cs
Important
This API is not CLS-compliant.
Converts the value of the specified 8-bit unsigned integer to the equivalent 16-bit unsigned integer.
public:
static System::UInt16 ToUInt16(System::Byte value);
[System.CLSCompliant(false)]
public static ushort ToUInt16 (byte value);
[<System.CLSCompliant(false)>]
static member ToUInt16 : byte -> uint16
Public Shared Function ToUInt16 (value As Byte) As UShort
Parameters
- value
- Byte
The 8-bit unsigned integer to convert.
Returns
A 16-bit unsigned integer that is equivalent to value
.
- Attributes
Examples
The following example converts each element in a byte array to an unsigned 16-bit integer.
byte[] bytes = { Byte.MinValue, 14, 122, Byte.MaxValue};
ushort result;
foreach (byte byteValue in bytes)
{
result = Convert.ToUInt16(byteValue);
Console.WriteLine("Converted the {0} value '{1}' to the {2} value {3}.",
byteValue.GetType().Name, byteValue,
result.GetType().Name, result);
}
// The example displays the following output:
// Converted the Byte value '0' to the UInt16 value 0.
// Converted the Byte value '14' to the UInt16 value 14.
// Converted the Byte value '122' to the UInt16 value 122.
// Converted the Byte value '255' to the UInt16 value 255.
let bytes = [| Byte.MinValue; 14uy; 122uy; Byte.MaxValue |]
for byteValue in bytes do
let result = Convert.ToUInt16 byteValue
printfn $"Converted the {byteValue.GetType().Name} value '{byteValue}' to the {result.GetType().Name} value {result}."
// The example displays the following output:
// Converted the Byte value '0' to the UInt16 value 0.
// Converted the Byte value '14' to the UInt16 value 14.
// Converted the Byte value '122' to the UInt16 value 122.
// Converted the Byte value '255' to the UInt16 value 255.
Dim bytes() As Byte = { Byte.MinValue, 14, 122, Byte.MaxValue}
Dim result As UShort
For Each number As Byte In bytes
result = Convert.ToUInt16(number)
Console.WriteLine("Converted the {0} value '{1}' to the {2} value {3}.", _
number.GetType().Name, number, _
result.GetType().Name, result)
Next
' The example displays the following output:
' Converted the Byte value '0' to the UInt16 value 0.
' Converted the Byte value '14' to the UInt16 value 14.
' Converted the Byte value '122' to the UInt16 value 122.
' Converted the Byte value '255' to the UInt16 value 255.
Applies to
.NET 9 and other versions
Product | Versions |
---|---|
.NET | Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9 |
.NET Framework | 1.1, 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1 |
.NET Standard | 1.0, 1.1, 1.2, 1.3, 1.4, 1.5, 1.6, 2.0, 2.1 |
UWP | 10.0 |
- Source:
- Convert.cs
- Source:
- Convert.cs
- Source:
- Convert.cs
Important
This API is not CLS-compliant.
Converts the specified Boolean value to the equivalent 16-bit unsigned integer.
public:
static System::UInt16 ToUInt16(bool value);
[System.CLSCompliant(false)]
public static ushort ToUInt16 (bool value);
[<System.CLSCompliant(false)>]
static member ToUInt16 : bool -> uint16
Public Shared Function ToUInt16 (value As Boolean) As UShort
Parameters
- value
- Boolean
The Boolean value to convert.
Returns
The number 1 if value
is true
; otherwise, 0.
- Attributes
Examples
The following example converts the Boolean values true
and false
to unsigned 16-bit integers.
bool falseFlag = false;
bool trueFlag = true;
Console.WriteLine("{0} converts to {1}.", falseFlag,
Convert.ToInt16(falseFlag));
Console.WriteLine("{0} converts to {1}.", trueFlag,
Convert.ToUInt16(trueFlag));
// The example displays the following output:
// False converts to 0.
// True converts to 1.
let falseFlag = false
let trueFlag = true
printfn $"{falseFlag} converts to {Convert.ToInt16 falseFlag}."
printfn $"{trueFlag} converts to {Convert.ToInt16 trueFlag}."
// The example displays the following output:
// False converts to 0.
// True converts to 1.
Dim falseFlag As Boolean = False
Dim trueFlag As Boolean = True
Console.WriteLine("{0} converts to {1}.", falseFlag, _
Convert.ToUInt16(falseFlag))
Console.WriteLine("{0} converts to {1}.", trueFlag, _
Convert.ToUInt16(trueFlag))
' The example displays the following output:
' False converts to 0.
' True converts to 1.
Applies to
.NET 9 and other versions
Product | Versions |
---|---|
.NET | Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9 |
.NET Framework | 1.1, 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1 |
.NET Standard | 1.0, 1.1, 1.2, 1.3, 1.4, 1.5, 1.6, 2.0, 2.1 |
UWP | 10.0 |
- Source:
- Convert.cs
- Source:
- Convert.cs
- Source:
- Convert.cs
Important
This API is not CLS-compliant.
Converts the value of the specified object to a 16-bit unsigned integer.
public:
static System::UInt16 ToUInt16(System::Object ^ value);
[System.CLSCompliant(false)]
public static ushort ToUInt16 (object value);
[System.CLSCompliant(false)]
public static ushort ToUInt16 (object? value);
[<System.CLSCompliant(false)>]
static member ToUInt16 : obj -> uint16
Public Shared Function ToUInt16 (value As Object) As UShort
Parameters
- value
- Object
An object that implements the IConvertible interface, or null
.
Returns
A 16-bit unsigned integer that is equivalent to value
, or zero if value
is null
.
- Attributes
Exceptions
value
is not in an appropriate format.
value
represents a number that is less than UInt16.MinValue or greater than UInt16.MaxValue.
Examples
The following example attempts to convert each element in an object array to an unsigned 16-bit integer.
object[] values= { true, -12, 163, 935, 'x', new DateTime(2009, 5, 12),
"104", "103.0", "-1", "1.00e2", "One", 1.00e2};
ushort result;
foreach (object value 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 (OverflowException) {
Console.WriteLine("The {0} value {1} is outside the range of the UInt16 type.",
value.GetType().Name, value);
}
catch (FormatException) {
Console.WriteLine("The {0} value {1} is not in a recognizable format.",
value.GetType().Name, value);
}
catch (InvalidCastException) {
Console.WriteLine("No conversion to a UInt16 exists for the {0} value {1}.",
value.GetType().Name, value);
}
}
// The example displays the following output:
// Converted the Boolean value 'True' to the UInt16 value 1.
// The Int32 value -12 is outside the range of the UInt16 type.
// Converted the Int32 value '163' to the UInt16 value 163.
// Converted the Int32 value '935' to the UInt16 value 935.
// Converted the Char value 'x' to the UInt16 value 120.
// No conversion to a UInt16 exists for the DateTime value 5/12/2009 12:00:00 AM.
// Converted the String value '104' to the UInt16 value 104.
// The String value 103.0 is not in a recognizable format.
// The String value -1 is outside the range of the UInt16 type.
// The String value 1.00e2 is not in a recognizable format.
// The String value One is not in a recognizable format.
// Converted the Double value '100' to the UInt16 value 100.
let values: obj[] =
[| true; -12; 163; 935; 'x'; DateTime(2009, 5, 12)
"104"; "103.0"; "-1"; "1.00e2"; "One"; 1.00e2 |]
for value in values do
try
let result = Convert.ToUInt16 value
printfn $"Converted the {value.GetType().Name} value '{value}' to the {result.GetType().Name} value {result}."
with
| :? OverflowException ->
printfn $"The {value.GetType().Name} value {value} is outside the range of the UInt16 type."
| :? FormatException ->
printfn $"The {value.GetType().Name} value {value} is not in a recognizable format."
| :? InvalidCastException ->
printfn $"No conversion to a UInt16 exists for the {value.GetType().Name} value {value}."
// The example displays the following output:
// Converted the Boolean value 'True' to the UInt16 value 1.
// The Int32 value -12 is outside the range of the UInt16 type.
// Converted the Int32 value '163' to the UInt16 value 163.
// Converted the Int32 value '935' to the UInt16 value 935.
// Converted the Char value 'x' to the UInt16 value 120.
// No conversion to a UInt16 exists for the DateTime value 5/12/2009 12:00:00 AM.
// Converted the String value '104' to the UInt16 value 104.
// The String value 103.0 is not in a recognizable format.
// The String value -1 is outside the range of the UInt16 type.
// The String value 1.00e2 is not in a recognizable format.
// The String value One is not in a recognizable format.
// Converted the Double value '100' to the UInt16 value 100.
Dim values() As Object = { True, -12, 163, 935, "x"c, #5/12/2009#, _
"104", "103.0", "-1", _
"1.00e2", "One", 1.00e2}
Dim result As UShort
For Each value As Object 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("The {0} value {1} is outside the range of the UInt16 type.", _
value.GetType().Name, value)
Catch e As FormatException
Console.WriteLine("The {0} value {1} is not in a recognizable format.", _
value.GetType().Name, value)
Catch e As InvalidCastException
Console.WriteLine("No conversion to an Int16 exists for the {0} value {1}.", _
value.GetType().Name, value)
End Try
Next
' The example displays the following output:
' Converted the Boolean value 'True' to the UInt16 value 1.
' The Int32 value -12 is outside the range of the UInt16 type.
' Converted the Int32 value '163' to the UInt16 value 163.
' Converted the Int32 value '935' to the UInt16 value 935.
' Converted the Char value 'x' to the UInt16 value 120.
' No conversion to an Int16 exists for the DateTime value 5/12/2009 12:00:00 AM.
' Converted the String value '104' to the UInt16 value 104.
' The String value 103.0 is not in a recognizable format.
' The String value -1 is outside the range of the UInt16 type.
' The String value 1.00e2 is not in a recognizable format.
' The String value One is not in a recognizable format.
' Converted the Double value '100' to the UInt16 value 100.
Remarks
The return value is the result of invoking the IConvertible.ToUInt16 method of the underlying type of value
.
Applies to
.NET 9 and other versions
Product | Versions |
---|---|
.NET | Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9 |
.NET Framework | 1.1, 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1 |
.NET Standard | 1.0, 1.1, 1.2, 1.3, 1.4, 1.5, 1.6, 2.0, 2.1 |
UWP | 10.0 |
- Source:
- Convert.cs
- Source:
- Convert.cs
- Source:
- Convert.cs
Important
This API is not CLS-compliant.
Converts the value of the specified double-precision floating-point number to an equivalent 16-bit unsigned integer.
public:
static System::UInt16 ToUInt16(double value);
[System.CLSCompliant(false)]
public static ushort ToUInt16 (double value);
[<System.CLSCompliant(false)>]
static member ToUInt16 : double -> uint16
Public Shared Function ToUInt16 (value As Double) As UShort
Parameters
- value
- Double
The double-precision floating-point number to convert.
Returns
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.
- Attributes
Exceptions
value
is less than zero or greater than UInt16.MaxValue.
Examples
The following example converts each element in an array of Double values to an unsigned 16-bit integer.
double[] numbers = { Double.MinValue, -1.38e10, -1023.299, -12.98,
0, 9.113e-16, 103.919, 17834.191, Double.MaxValue };
ushort result;
foreach (double 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:
// -1.79769313486232E+308 is outside the range of the UInt16 type.
// -13800000000 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 Double value '0' to the UInt16 value 0.
// Converted the Double value '9.113E-16' to the UInt16 value 0.
// Converted the Double value '103.919' to the UInt16 value 104.
// Converted the Double value '17834.191' to the UInt16 value 17834.
// 1.79769313486232E+308 is outside the range of the UInt16 type.
let numbers =
[| Double.MinValue; -1.38e10; -1023.299; -12.98
0; 9.113e-16; 103.919; 17834.191; Double.MaxValue |]
for number in numbers do
try
let result = Convert.ToUInt16 number
printfn $"Converted the {number.GetType().Name} value '{number}' to the {result.GetType().Name} value {result}."
with :? OverflowException ->
printfn $"{number} is outside the range of the UInt16 type."
// The example displays the following output:
// -1.79769313486232E+308 is outside the range of the UInt16 type.
// -13800000000 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 Double value '0' to the UInt16 value 0.
// Converted the Double value '9.113E-16' to the UInt16 value 0.
// Converted the Double value '103.919' to the UInt16 value 104.
// Converted the Double value '17834.191' to the UInt16 value 17834.
// 1.79769313486232E+308 is outside the range of the UInt16 type.
Dim values() As Double = { Double.MinValue, -1.38e10, -1023.299, -12.98, _
0, 9.113e-16, 103.919, 17834.191, Double.MaxValue }
Dim result As UShort
For Each value As Double 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:
' -1.79769313486232E+308 is outside the range of the UInt16 type.
' -13800000000 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 Double value '0' to the UInt16 value 0.
' Converted the Double value '9.113E-16' to the UInt16 value 0.
' Converted the Double value '103.919' to the UInt16 value 104.
' Converted the Double value '17834.191' to the UInt16 value 17834.
' 1.79769313486232E+308 is outside the range of the UInt16 type.
See also
Applies to
.NET 9 and other versions
Product | Versions |
---|---|
.NET | Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9 |
.NET Framework | 1.1, 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1 |
.NET Standard | 1.0, 1.1, 1.2, 1.3, 1.4, 1.5, 1.6, 2.0, 2.1 |
UWP | 10.0 |
.NET feedback
.NET is an open source project. Select a link to provide feedback: