System.UInt32 Structure

Summary

Represents a 32-bit unsigned integer.

This class is not CLS Compliant

C# Syntax:

[CLSCompliant(false)] [Serializable] public struct UInt32 : IComparable, IFormattable, IConvertible

This type is safe for multithreaded operations.

The UInt32 value type represents unsigned integers with values ranging from 0 to 4,294,967,295.

UInt32 provides methods to compare instances of this type, convert the value of an instance to its String representation, and convert the String representation of a number to an instance of this type.

For information about how format specification codes control the String representation of value types, see the conceptual topic at MSDN: formattingoverview.

This type implements interfaces IComparable, IFormattable, and IConvertible. Use the Convert class for conversions instead of this type's explicit interface member implementation of IConvertible.

System Namespace | Int32

System.UInt32 Member List:

Public Fields

MaxValue	Represents the largest possible value of UInt32. This field is constant.
MinValue	Represents the smallest possible value of UInt32. This field is constant.

Public Methods

CompareTo	Compares this instance to a specified object and returns an indication of their relative values.
Equals	Overridden: Returns a value indicating whether this instance is equal to a specified object.
GetHashCode	Overridden: Returns the hash code for this instance.
GetType (inherited from System.Object)	See base class member description: System.Object.GetType Derived from System.Object, the primary base class for all objects.
GetTypeCode	Returns the TypeCode for value type UInt32.
Parse	Overloaded: Parse(string s) Converts the string representation of a number to its 32-bit unsigned integer equivalent.
Parse	Overloaded: Parse(string s, IFormatProvider provider) Converts the string representation of a number in a specified culture-specific format to its 32-bit unsigned integer equivalent.
Parse	Overloaded: Parse(string s, NumberStyles style) Converts the string representation of a number in a specified style to its 32-bit unsigned integer equivalent.
Parse	Overloaded: Parse(string s, NumberStyles style, IFormatProvider provider) Converts the string representation of a number in a specified style and culture-specific format to its 32-bit unsigned integer equivalent.
ToString	Overloaded: ToString() Overridden: Converts the numeric value of this instance to its equivalent string representation.
ToString	Overloaded: ToString(IFormatProvider provider) Converts the numeric value of this instance to its equivalent string representation using the specified culture-specific format information.
ToString	Overloaded: ToString(string format) Converts the numeric value of this instance to its equivalent string representation using the specified format.
ToString	Overloaded: ToString(string format, IFormatProvider provider) Converts the numeric value of this instance to its equivalent string representation using the specified format and culture-specific format information.

Protected Methods

Finalize (inherited from System.Object)	See base class member description: System.Object.Finalize Derived from System.Object, the primary base class for all objects.
MemberwiseClone (inherited from System.Object)	See base class member description: System.Object.MemberwiseClone Derived from System.Object, the primary base class for all objects.

Hierarchy:

• System.Object
• System.ValueType
• System.UInt32

System.UInt32 Member Details

Summary

Represents the largest possible value of UInt32. This field is constant.

This class is not CLS Compliant

C# Syntax:

public const uint MaxValue;

The value of this constant is 4,294,967,295; that is, hexadecimal 0xFFFFFFFF.

Return to top

Summary

Represents the smallest possible value of UInt32. This field is constant.

This class is not CLS Compliant

C# Syntax:

public const uint MinValue;

The value of this constant is 0.

Return to top

Summary

Compares this instance to a specified object and returns an indication of their relative values.

This class is not CLS Compliant

C# Syntax:

public int CompareTo(    object value );

value

An object to compare, or null.

Return Value:

A signed number indicating the relative values of this instance and value.

Return Value	Description
Less than zero	This instance is less than .
Zero	This instance is equal to .
Greater than zero	This instance is greater than value. -or- value is null.

Exceptions

Exception Type	Condition
ArgumentException	value is not a UInt32.

Any instance of UInt32, regardless of its value, is considered greater than null.

The value parameter must be null or an instance of UInt32; otherwise, an exception is thrown.

Return to top

Summary

Returns a value indicating whether this instance is equal to a specified object.

This class is not CLS Compliant

C# Syntax:

public override bool Equals(    object obj );

obj

An object to compare with this instance.

Return Value:

true if obj is an instance of UInt32 and equals the value of this instance; otherwise, false.

The following sample demonstrates the UInt32.Equals method.

            UInt32 myVariable1 = 20;
            UInt32 myVariable2 = 20;

            // Display the declaring type.
            Console.WriteLine("\nType of 'myVariable1' is '{0}' and"+
                 " value is :{1}",myVariable1.GetType(), myVariable1); 
            Console.WriteLine("Type of 'myVariable2' is '{0}' and"+
                 " value is :{1}",myVariable2.GetType(), myVariable2);

            // Compare 'myVariable1' instance with 'myVariable2' Object.
            if( myVariable1.Equals( myVariable2 ) )
               Console.WriteLine( "\nStructures 'myVariable1' and "+
                     "'myVariable2' are equal");
            else
               Console.WriteLine( "\nStructures 'myVariable1' and "+
                     "'myVariable2' are not equal");

    

Return to top

Inherited
See base class member description: System.Object.Finalize

This class is not CLS Compliant

C# Syntax:

~UInt32();

For more information on members inherited from System.Object click on the link above.

Return to top

Summary

Returns the hash code for this instance.

This class is not CLS Compliant

C# Syntax:

public override int GetHashCode();

Return Value:

A 32-bit signed integer hash code.

Return to top

Inherited
See base class member description: System.Object.GetType

This class is not CLS Compliant

C# Syntax:

public Type GetType();

For more information on members inherited from System.Object click on the link above.

Return to top

Summary

Returns the TypeCode for value type UInt32.

This class is not CLS Compliant

C# Syntax:

public TypeCode GetTypeCode();

Return Value:

The enumerated constant, TypeCode.UInt32.

Return to top

Inherited
See base class member description: System.Object.MemberwiseClone

This class is not CLS Compliant

C# Syntax:

protected object MemberwiseClone();

For more information on members inherited from System.Object click on the link above.

Return to top

Summary

Converts the string representation of a number to its 32-bit unsigned integer equivalent.

This class is not CLS Compliant

This member is not CLS Compliant

C# Syntax:

[CLSCompliant(false)] public static uint Parse(    string s );

s

A string representing the number to convert.

Return Value:

A 32-bit unsigned integer equivalent to the number contained in s.

Exceptions

Exception Type	Condition
ArgumentNullException	The s parameter is null.
FormatException	The s parameter is not of the correct format.
OverflowException	The s parameter represents a number less than UInt32.MinValue or greater than UInt32.MaxValue.

The s parameter contains a number of the form:

[ws][sign]digits[ws]

Items in square brackets ('[' and ']') are optional, and other items are as follows.

ws Optional white space. sign An optional positive sign. digits A sequence of digits ranging from 0 to 9.

The s parameter is parsed using the formatting information in a NumberFormatInfo initialized for the current system culture. For more information, see NumberFormatInfo.CurrentInfo.

Return to top

Summary

Converts the string representation of a number in a specified culture-specific format to its 32-bit unsigned integer equivalent.

This class is not CLS Compliant

This member is not CLS Compliant

C# Syntax:

[CLSCompliant(false)] public static uint Parse(    string s,    IFormatProvider provider );

s

A string representing the number to convert.

provider

An IFormatProvider that supplies culture-specific formatting information about s.

Return Value:

A 32-bit unsigned integer equivalent to the number specified in s.

Exceptions

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

The s parameter contains a number of the form:

[ws][sign]digits[ws]

Items in square brackets ('[' and ']') are optional, and other items are as follows.

ws Optional white space. sign An optional positive sign. digits A sequence of digits ranging from 0 to 9.

The provider parameter is an IFormatProvider that obtains a NumberFormatInfo. The NumberFormatInfo provides culture-specific information about the format of s. If provider is null, the NumberFormatInfo for the current culture is used.

Return to top

Summary

Converts the string representation of a number in a specified style to its 32-bit unsigned integer equivalent.

This class is not CLS Compliant

This member is not CLS Compliant

C# Syntax:

[CLSCompliant(false)] public static uint Parse(    string s,    NumberStyles style );

s

A string representing the number to convert.

style

The combination of one or more NumberStyles constants that indicate the permitted format of s.

Return Value:

A 32-bit unsigned integer equivalent to the number specified in s.

Exceptions

Exception Type	Condition
ArgumentNullException	s is null.
ArgumentException	style is not a valid combination of bit flags from the NumberStyles enumeration.
FormatException	s is not in a format compliant with style.
OverflowException	s represents a number less than UInt32.MinValue or greater than UInt32.MaxValue.

The s parameter contains a number of the form:

[ws][sign]digits[ws]

Items in square brackets ('[' and ']') are optional, and other items are as follows.

ws Optional white space. sign An optional positive sign. digits A sequence of digits ranging from 0 to 9.

The style parameter can be one or more NumberStyles enumerated constants combined using a bitwise OR operation (except NumberStyles.Any and NumberStyles.AllowDecimalPoint, which are invalid for the type returned by this method).

Return to top

Summary

Converts the string representation of a number in a specified style and culture-specific format to its 32-bit unsigned integer equivalent.

This class is not CLS Compliant

This member is not CLS Compliant

C# Syntax:

[CLSCompliant(false)] public static uint Parse(    string s,    NumberStyles style,    IFormatProvider provider );

s

A string representing the number to convert.

style

The combination of one or more NumberStyles constants that indicate the permitted format of s.

provider

An IFormatProvider that supplies culture-specific formatting information about s.

Return Value:

A 32-bit unsigned integer equivalent to the number specified in s.

Exceptions

Exception Type	Condition
ArgumentNullException	s is null.
ArgumentException	style is not a valid combination of NumberStyles enumerated constants.
FormatException	s is not in a format compliant with style.
OverflowException	s represents a number less than UInt32.MinValue or greater than UInt32.MaxValue.

The s parameter contains a number of the form:

[ws][sign]digits[ws]

Items in square brackets ('[' and ']') are optional, and other items are as follows.

ws Optional white space. sign An optional positive sign. digits A sequence of digits ranging from 0 to 9.

The style parameter can be one or more NumberStyles enumerated constants combined using a bitwise OR operation (except NumberStyles.Any and NumberStyles.AllowDecimalPoint, which are invalid for the type returned by this method).

The provider parameter is an IFormatProvider that obtains a NumberFormatInfo. The NumberFormatInfo provides culture-specific information about the format of s. If provider is null, the NumberFormatInfo for the current culture is used.

Return to top

Summary

Converts the numeric value of this instance to its equivalent string representation.

This class is not CLS Compliant

C# Syntax:

public override string ToString();

Return Value:

The string representation of the value of this instance, consisting of a sequence of digits ranging from 0 to 9, without a sign or leading zeroes.

The return value is formatted with the general format specifier ("G") and the NumberFormatInfo for the current culture.

Return to top

Summary

Converts the numeric value of this instance to its equivalent string representation using the specified culture-specific format information.

This class is not CLS Compliant

C# Syntax:

public string ToString(    IFormatProvider provider );

provider

An IFormatProvider that supplies culture-specific formatting information.

Return Value:

The string representation of the value of this instance as specified by provider.

This instance is formatted with the general format specifier ("G").

The provider parameter is an IFormatProvider that obtains a NumberFormatInfo. The NumberFormatInfo provides culture-specific format information about this instance. If provider is null, this instance is formatted with the NumberFormatInfo for the current culture.

Return to top

Summary

Converts the numeric value of this instance to its equivalent string representation using the specified format.

This class is not CLS Compliant

C# Syntax:

public string ToString(    string format );

format

A format string.

Return Value:

The string representation of the value of this instance as specified by format.

Exceptions

Exception Type	Condition
FormatException	The format parameter is invalid.

If format is null or an empty string (""), the return value of this instance is formatted with the general format specifier ("G").

The return value of this instance is formatted with the NumberFormatInfo for the current culture.

Return to top

Summary

Converts the numeric value of this instance to its equivalent string representation using the specified format and culture-specific format information.

This class is not CLS Compliant

C# Syntax:

public string ToString(    string format,    IFormatProvider provider );

format

A format specification.

provider

An IFormatProvider that supplies culture-specific formatting information about this instance.

Return Value:

The string representation of the value of this instance as specified by format and provider.

Exceptions

Exception Type	Condition
FormatException	The format parameter is invalid.

If format is null or an empty string (""), the return value for this instance is formatted with the general format specifier ("G").

The provider parameter is an IFormatProvider that obtains a NumberFormatInfo. The NumberFormatInfo provides culture-specific format information about this instance. If provider is null, the return value for this instance is formatted with the NumberFormatInfo for the current culture.

Return to top

Top of page