System.UInt16 Structure

public struct UInt16 : IComparable, IFormattable, IComparable<UInt16>, IEquatable<UInt16>

Base Types

Object
  ValueType
    UInt16

This type implements IComparable, IFormattable, System.IComparable<System.UInt16>, and System.IEquatable<System.UInt16>.

Assembly

mscorlib

Library

BCL

Summary

Represents a 16-bit unsigned integer.

Description

The UInt16 data type represents integer values ranging from 0 to positive 65,535 (hexadecimal 0xFFFF).

Attributes

CLSCompliantAttribute(false)

See Also

System Namespace

Members

UInt16 Methods

UInt16.CompareTo(System.Object) Method
UInt16.CompareTo(ushort) Method
UInt16.Equals(System.Object) Method
UInt16.Equals(ushort) Method
UInt16.GetHashCode Method
UInt16.Parse(System.String) Method
UInt16.Parse(System.String, System.Globalization.NumberStyles) Method
UInt16.Parse(System.String, System.IFormatProvider) Method
UInt16.Parse(System.String, System.Globalization.NumberStyles, System.IFormatProvider) Method
UInt16.ToString(System.IFormatProvider) Method
UInt16.ToString(System.String, System.IFormatProvider) Method
UInt16.ToString() Method
UInt16.ToString(System.String) Method

UInt16 Fields

UInt16.MaxValue Field
UInt16.MinValue Field

UInt16.CompareTo(System.Object) Method

public int CompareTo(object value);

Summary

Returns the sort order of the current instance compared to the specified Object.

Parameters

value
The Object to compare to the current instance.

Return Value

The return value is a negative number, zero, or a positive number reflecting the sort order of the current instance as compared to value. For non-zero return values, the exact value returned by this method is unspecified. The following table defines the return value:

Return ValueDescription
A negative numberCurrent instance < value.
ZeroCurrent instance == value.
A positive numberCurrent instance > value, or value is a null reference.

Exceptions

Exception TypeCondition
ArgumentExceptionvalue is not a UInt16 and is not a null reference.

Description

[Note: This method is implemented to support the IComparable interface.]

See Also

System.UInt16 Structure, System Namespace

UInt16.CompareTo(ushort) Method

public int CompareTo(ushort value);

Summary

Returns the sort order of the current instance compared to the specified UInt16.

Parameters

value
The UInt16 to compare to the current instance.

Return Value

The return value is a negative number, zero, or a positive number reflecting the sort order of the current instance as compared to value. For non-zero return values, the exact value returned by this method is unspecified. The following table defines the return value:

Return ValueDescription
A negative numberCurrent instance < value.
ZeroCurrent instance == value.
A positive numberCurrent instance > value.

Description

[Note: This method is implemented to support the System.IComparable<UInt16> interface.]

See Also

System.UInt16 Structure, System Namespace

UInt16.Equals(System.Object) Method

public override bool Equals(object obj);

Summary

Determines whether the current instance and the specified Object represent the same value and type.

Parameters

obj
The Object to compare to the current instance.

Return Value

true if obj represents the same value and type as the current instance. If obj is a null reference or is not an instance of UInt16, returns false .

Description

[Note: This method overrides System.Object.Equals(System.Object).]

See Also

System.UInt16 Structure, System Namespace

UInt16.Equals(ushort) Method

public override bool Equals(ushort obj);

Summary

Determines whether the current instance and the specified UInt16 represent the same type.

Parameters

obj
The UInt16 to compare to the current instance.

Return Value

true if obj represents the same value and type as the current instance; otherwise, false .

Description

[Note: This method is implemented to support the System.IEquatable<UInt16> interface.]

See Also

System.UInt16 Structure, System Namespace

UInt16.GetHashCode Method

public override int GetHashCode();

Summary

Generates a hash code for the current instance.

Return Value

A Int32 containing the hash code for the current instance.

Description

The algorithm used to generate the hash code is unspecified.

[Note: This method overrides System.Object.GetHashCode.]

See Also

System.UInt16 Structure, System Namespace

UInt16.Parse(System.String) Method

public static ushort Parse(string s);

Summary

Returns the specified String converted to a UInt16 value.

Parameters

s
A String containing the value to convert. The string is interpreted using the System.Globalization.NumberStyles.Integer style.

Return Value

The UInt16 value obtained from s.

Exceptions

Exception TypeCondition
ArgumentNullExceptions is a null reference.
FormatExceptions is not in the correct style.
OverflowExceptions represents a number greater than System.UInt16.MaxValue or less than System.UInt16.MinValue.

Description

This version of System.UInt16.Parse(System.String) is equivalent to System.UInt16.Parse(System.String)(s, System.Globalization.NumberStyles.Integer, null ).

The string s is parsed using the formatting information in a NumberFormatInfo initialized for the current system culture. [Note: For more information, see System.Globalization.NumberFormatInfo.CurrentInfo.]

This method is not CLS-compliant. For a CLS-compliant alternative use System.Int32.Parse(System.String)(String).

Example

This example demonstrates parsing a string to a UInt16.

using System;
public class UInt16ParseClass {
  public static void Main() {
    string str = "  100   ";
    Console.WriteLine("String: \"{0}\" <UInt16> {1}",str,UInt16.Parse(str));
  }
}
The output is

String: " 100 " <UInt16> 100

Attributes

CLSCompliantAttribute(false)

See Also

System.UInt16 Structure, System Namespace

UInt16.Parse(System.String, System.Globalization.NumberStyles) Method

public static ushort Parse(string s, NumberStyles style);

Summary

Returns the specified String converted to a UInt16 value.

Parameters

s
A String containing the value to convert. The string is interpreted using the style specified by style.
style
Zero or more NumberStyles values that specify the style of s. Specify multiple values for style using the bitwise OR operator. If style is a null reference, the string is interpreted using the System.Globalization.NumberStyles.Integer style.

Return Value

The UInt16 value obtained from s.

Exceptions

Exception TypeCondition
ArgumentNullExceptions is a null reference.
FormatExceptions is not in the correct style.
OverflowExceptions represents a number greater than System.UInt16.MaxValue or less than System.UInt16.MinValue.

Description

This version of System.UInt16.Parse(System.String) is equivalent to System.UInt16.Parse(System.String)(s, style, null ).

The string s is parsed using the formatting information in a NumberFormatInfo initialized for the current system culture. [Note: For more information, see System.Globalization.NumberFormatInfo.CurrentInfo.]

This method is not CLS-compliant. For a CLS-compliant alternative use System.Int32.Parse(System.String)(String,NumberStyles).

Attributes

CLSCompliantAttribute(false)

See Also

System.UInt16 Structure, System Namespace

UInt16.Parse(System.String, System.IFormatProvider) Method

public static ushort Parse(string s, IFormatProvider provider);

Summary

Returns the specified String converted to a UInt16 value.

Parameters

s
A String containing the value to convert. The string is interpreted using the System.Globalization.NumberStyles.Integer style.
provider
A IFormatProvider that supplies a NumberFormatInfo containing culture-specific formatting information about s.

Return Value

The UInt16 value obtained from s.

Exceptions

Exception TypeCondition
ArgumentNullExceptions is a null reference.
FormatExceptions is not in the correct style.
OverflowExceptions represents a number greater than System.UInt16.MaxValue or less than System.UInt16.MinValue.

Description

This version of System.UInt16.Parse(System.String) is equivalent to System.UInt16.Parse(System.String) (s , System.Globalization.NumberStyles.Integer, provider).

The string s is parsed using the culture-specific formatting information from the NumberFormatInfo instance supplied by provider. If provider is null or a NumberFormatInfo cannot be obtained from provider, the formatting information for the current system culture is used.

This method is not CLS-compliant. For a CLS-compliant alternative use System.Int32.Parse(System.String)(String,IFormatProvider ).

Attributes

CLSCompliantAttribute(false)

See Also

System.UInt16 Structure, System Namespace

UInt16.Parse(System.String, System.Globalization.NumberStyles, System.IFormatProvider) Method

public static ushort Parse(string s, NumberStyles style, IFormatProvider provider);

Summary

Returns the specified String converted to a UInt16 value.

Parameters

s
A String containing the value to convert. The string is interpreted using the style specified by style.
style
Zero or more NumberStyles values that specify the style of s. Specify multiple values for style using the bitwise OR operator. If style is a null reference, the string is interpreted using the System.Globalization.NumberStyles.Integer style.
provider
A IFormatProvider that supplies a NumberFormatInfo containing culture-specific formatting information about s.

Return Value

The UInt16 value obtained from s.

Exceptions

Exception TypeCondition
ArgumentNullExceptions is a null reference.
FormatExceptions is not in the correct style.
OverflowExceptions represents a number greater than System.UInt16.MaxValue or less than System.UInt16.MinValue.

Description

The string s is parsed using the culture-specific formatting information from the NumberFormatInfo instance supplied by provider. If provider is null or a NumberFormatInfo cannot be obtained from provider, the formatting information for the current system culture is used.

This method is not CLS-compliant. For a CLS-compliant alternative use System.Int32.Parse(System.String)(String, NumberStyles, IFormatProvider).

Attributes

CLSCompliantAttribute(false)

See Also

System.UInt16 Structure, System Namespace

UInt16.ToString(System.IFormatProvider) Method

public string ToString(IFormatProvider provider);

Summary

Returns a String representation of the value of the current instance.

Parameters

provider
A IFormatProvider that supplies a NumberFormatInfo containing culture-specific formatting information.

Return Value

A String representation of the current instance formatted using the general format specifier, ("G"). The string takes into account the formatting information in the NumberFormatInfo instance supplied by provider.

Description

This version of System.UInt16.ToString is equivalent to System.UInt16.ToString("G", provider).

If provider is null or a NumberFormatInfo cannot be obtained from provider, the formatting information for the current system culture is used.

See Also

System.UInt16 Structure, System Namespace

UInt16.ToString(System.String, System.IFormatProvider) Method

public string ToString(string format, IFormatProvider provider);

Summary

Returns a String representation of the value of the current instance.

Parameters

format
A String containing a character that specifies the format of the returned string.
provider
A IFormatProvider that supplies a NumberFormatInfo instance containing culture-specific formatting information.

Return Value

A String representation of the current instance formatted as specified by format. The string takes into account the formatting information in the NumberFormatInfo instance supplied by provider.

Exceptions

Exception TypeCondition
FormatExceptionformat is invalid.

Description

If provider is null or a NumberFormatInfo cannot be obtained from provider, the formatting information for the current system culture is used.

If format is a null reference, the general format specifier "G" is used.

[Note: For a detailed description of formatting, see the IFormattable interface.

This method is implemented to support the IFormattable interface.

]

The following table lists the characters that are valid for the UInt16 type.

Format CharactersDescription
"C", "c"Currency format.
"D", "d"Decimal format.
"E", "e"Exponential notation format.
"F", "f"Fixed-point format.
"G", "g"General format.
"N", "n"Number format.
"P", "p"Percent format.
"X", "x"Hexadecimal format.

See Also

System.UInt16 Structure, System Namespace

UInt16.ToString() Method

public override string ToString();

Summary

Returns a String representation of the value of the current instance.

Return Value

A String representation of the current instance formatted using the general format specifier ("G"). The string takes into account the current system culture.

Description

This version of System.UInt16.ToString is equivalent to System.UInt16.ToString(null , null ).

[Note: This method overrides System.Object.ToString.]

See Also

System.UInt16 Structure, System Namespace

UInt16.ToString(System.String) Method

public string ToString(string format);

Summary

Returns a String representation of the value of the current instance.

Parameters

format
A String that specifies the format of the returned string. [Note: For a list of valid values, see System.UInt16.ToString(String, IFormatProvider).]

Return Value

A String representation of the current instance formatted as specified by format. The string takes into account the current system culture.

Exceptions

Exception TypeCondition
FormatExceptionformat is invalid.

Description

This method is equivalent to System.UInt16.ToString(format, null).

If format is a null reference, the general format specifier "G" is used.

Example

This example demonstrates converting a UInt16 to a string.

using System;
public class UInt16ToStringExample {
   public static void Main() {
      UInt16 i = 16;
      Console.WriteLine(i);
      String[] formats = {"c", "d", "e", "f", "g", "n", "p", "x" };
      foreach(String str in formats)
         Console.WriteLine("{0}: {1}", str, i.ToString(str));
   }
}
The output is

16

c: $16.00

d: 16

e: 1.600000e+001

f: 16.00

g: 16

n: 16.00

p: 1,600.00 %

x: 10

See Also

System.UInt16 Structure, System Namespace

UInt16.MaxValue Field

public const ushort MaxValue = 65535;

Summary

Contains the maximum value for the UInt16 type.

Description

The value of this constant is 65,535 (hexadecimal 0xFFFF).

See Also

System.UInt16 Structure, System Namespace

UInt16.MinValue Field

public const ushort MinValue = 0;

Summary

Contains the minimum value for the UInt16 type.

Description

The value of this constant is 0.

See Also

System.UInt16 Structure, System Namespace