System.UInt32 Structure

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

Base Types

Object
  ValueType
    UInt32

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

Assembly

mscorlib

Library

BCL

Summary

Represents a 32-bit unsigned integer.

Description

The UInt32 data type represents integer values ranging from 0 to positive 4,294,967,295 (hexadecimal 0xFFFFFFFF).

Attributes

CLSCompliantAttribute(false)

See Also

System Namespace

Members

UInt32 Methods

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

UInt32 Fields

UInt32.MaxValue Field
UInt32.MinValue Field

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 Value	Description
A negative number	Current instance < value.
Zero	Current instance == value.
A positive number	Current instance > value, or value is a null reference.

Exceptions

Exception Type	Condition
ArgumentException	value is not a UInt32 and is not a null reference.

Description

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

See Also

System.UInt32 Structure, System Namespace

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

Parameters

value

The UInt32 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 Value	Description
A negative number	Current instance < value.
Zero	Current instance == value.
A positive number	Current instance > value.

Description

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

See Also

System.UInt32 Structure, System Namespace

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

Parameters

obj

The Object to compare to the current instance.

Return Value

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

Description

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

See Also

System.UInt32 Structure, System Namespace

Determines whether the current instance and the specified UInt32 represent the same value.

Parameters

obj

The UInt32 to compare to the current instance.

Return Value

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

Description

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

See Also

System.UInt32 Structure, System Namespace

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.UInt32 Structure, System Namespace

Returns the specified String converted to a UInt32 value.

Parameters

s

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

Return Value

The UInt32 value obtained from s.

Exceptions

Exception Type	Condition
ArgumentNullException	s is a null reference.
FormatException	s is not in the correct style.
OverflowException	s represents a number greater than System.UInt32.MaxValue or less than System.UInt32.MinValue.

Description

This version of System.UInt32.Parse(System.String) is equivalent to System.UInt32.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.Int64.Parse(System.String)(String).

Example

This example demonstrates parsing a string to a UInt32.

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

The output is

String: " 100 " <UInt32> 100

Attributes

CLSCompliantAttribute(false)

See Also

System.UInt32 Structure, System Namespace

Returns the specified String converted to a UInt32 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 UInt32 value obtained from s.

Exceptions

Exception Type	Condition
ArgumentNullException	s is a null reference.
FormatException	s is not in the correct style.
OverflowException	s represents a number greater than System.UInt32.MaxValue or less than System.UInt32.MinValue.

Description

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

The string 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.Int64.Parse(System.String)(String, NumberStyles).

Attributes

CLSCompliantAttribute(false)

See Also

System.UInt32 Structure, System Namespace

Returns the specified String converted to a UInt32 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 UInt32 value obtained from s.

Exceptions

Exception Type	Condition
ArgumentNullException	s is a null reference.
FormatException	s is not in the correct style.
OverflowException	s represents a number greater than System.UInt32.MaxValue or less than System.UInt32.MinValue.

Description

This version of System.UInt32.Parse(System.String) is equivalent to System.UInt32.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.Int64.Parse(System.String) (String, IFormatProvider).

Attributes

CLSCompliantAttribute(false)

See Also

System.UInt32 Structure, System Namespace

Returns the specified String converted to a UInt32 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 UInt32 value obtained from s.

Exceptions

Exception Type	Condition
ArgumentNullException	s is a null reference.
FormatException	s is not in the correct style.
OverflowException	s represents a number greater than System.UInt32.MaxValue or less than System.UInt32.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.Int64.Parse(System.String)(String, NumberStyles, IFormatProvider).

Attributes

CLSCompliantAttribute(false)

See Also

System.UInt32 Structure, System Namespace

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.UInt32.ToString is equivalent to System.UInt32.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.UInt32 Structure, System Namespace

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 Type	Condition
FormatException	format 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 UInt32 type.

Format Characters	Description
"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.UInt32 Structure, System Namespace

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.UInt32.ToString is equivalent to System.UInt32.ToString (null , null ).

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

See Also

System.UInt32 Structure, System Namespace

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.UInt32.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 Type	Condition
FormatException	format is invalid.

Description

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

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

Example

This example demonstrates converting a UInt32 to a string.

using System;
public class UInt32ToStringExample {
   public static void Main() {
      UInt32 i = 32;
      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

32

c: $32.00

d: 32

e: 3.200000e+001

f: 32.00

g: 32

n: 32.00

p: 3,200.00 %

x: 20

See Also

System.UInt32 Structure, System Namespace

Contains the maximum value for the UInt32 type.

Description

The value of this constant is 4,294,967,295 (hexadecimal 0xFFFFFFFF).

See Also

System.UInt32 Structure, System Namespace

Contains the minimum value for the UInt32 type.

Description

The value of this constant is 0.

See Also

System.UInt32 Structure, System Namespace