mscorlib(4.0.0.0) API with additions
System.UInt32 Struct Reference

Represents a 32-bit unsigned integer. More...

Inheritance diagram for System.UInt32:
[legend]
Collaboration diagram for System.UInt32:
[legend]

Public Member Functions

int CompareTo (object value)
 Compares this instance to a specified object and returns an indication of their relative values. More...
 
int CompareTo (uint value)
 Compares this instance to a specified 32-bit unsigned integer and returns an indication of their relative values. More...
 
override bool Equals (object obj)
 Returns a value indicating whether this instance is equal to a specified object. More...
 
bool Equals (uint obj)
 Returns a value indicating whether this instance is equal to a specified T:System.UInt32. More...
 
override int GetHashCode ()
 Returns the hash code for this instance. More...
 
override string ToString ()
 Converts the numeric value of this instance to its equivalent string representation. More...
 
string ToString (IFormatProvider provider)
 Converts the numeric value of this instance to its equivalent string representation using the specified culture-specific format information. More...
 
string ToString (string format)
 Converts the numeric value of this instance to its equivalent string representation using the specified format. More...
 
string 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. More...
 
TypeCode GetTypeCode ()
 Returns the T:System.TypeCode for value type T:System.UInt32. More...
 
bool IConvertible. ToBoolean (IFormatProvider provider)
 For a description of this member, see M:System.IConvertible.ToBoolean(System.IFormatProvider). More...
 
char IConvertible. ToChar (IFormatProvider provider)
 For a description of this member, see M:System.IConvertible.ToChar(System.IFormatProvider). More...
 
sbyte IConvertible. ToSByte (IFormatProvider provider)
 For a description of this member, see M:System.IConvertible.ToSByte(System.IFormatProvider). More...
 
byte IConvertible. ToByte (IFormatProvider provider)
 For a description of this member, see M:System.IConvertible.ToByte(System.IFormatProvider). More...
 
short IConvertible. ToInt16 (IFormatProvider provider)
 For a description of this member, see M:System.IConvertible.ToInt16(System.IFormatProvider). More...
 
ushort IConvertible. ToUInt16 (IFormatProvider provider)
 For a description of this member, see M:System.IConvertible.ToUInt16(System.IFormatProvider). More...
 
int IConvertible. ToInt32 (IFormatProvider provider)
 For a description of this member, see M:System.IConvertible.ToInt32(System.IFormatProvider). More...
 
uint IConvertible. ToUInt32 (IFormatProvider provider)
 For a description of this member, see M:System.IConvertible.ToUInt32(System.IFormatProvider). More...
 
long IConvertible. ToInt64 (IFormatProvider provider)
 For a description of this member, see M:System.IConvertible.ToInt64(System.IFormatProvider). More...
 
ulong IConvertible. ToUInt64 (IFormatProvider provider)
 For a description of this member, see M:System.IConvertible.ToUInt64(System.IFormatProvider). More...
 
float IConvertible. ToSingle (IFormatProvider provider)
 For a description of this member, see M:System.IConvertible.ToSingle(System.IFormatProvider). More...
 
double IConvertible. ToDouble (IFormatProvider provider)
 For a description of this member, see M:System.IConvertible.ToDouble(System.IFormatProvider). More...
 
decimal IConvertible. ToDecimal (IFormatProvider provider)
 For a description of this member, see M:System.IConvertible.ToDecimal(System.IFormatProvider). More...
 
DateTime IConvertible. ToDateTime (IFormatProvider provider)
 This conversion is not supported. Attempting to use this method throws an T:System.InvalidCastException. More...
 
object IConvertible. ToType (Type type, IFormatProvider provider)
 For a description of this member, see M:System.IConvertible.ToType(System.Type,System.IFormatProvider). More...
 
- Public Member Functions inherited from System.IEquatable< uint >
bool Equals (T other)
 Indicates whether the current object is equal to another object of the same type. More...
 

Static Public Member Functions

static uint Parse (string s)
 Converts the string representation of a number to its 32-bit unsigned integer equivalent. More...
 
static uint Parse (string s, NumberStyles style)
 Converts the string representation of a number in a specified style to its 32-bit unsigned integer equivalent. More...
 
static uint 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. More...
 
static uint 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. More...
 
static bool TryParse (string s, out uint result)
 Tries to convert the string representation of a number to its 32-bit unsigned integer equivalent. A return value indicates whether the conversion succeeded or failed. More...
 
static bool TryParse (string s, NumberStyles style, IFormatProvider provider, out uint result)
 Tries to convert the string representation of a number in a specified style and culture-specific format to its 32-bit unsigned integer equivalent. A return value indicates whether the conversion succeeded or failed. More...
 

Public Attributes

const uint MaxValue = 4294967295u
 Represents the largest possible value of T:System.UInt32. This field is constant. More...
 
const uint MinValue = 0u
 Represents the smallest possible value of T:System.UInt32. This field is constant. More...
 

Detailed Description

Represents a 32-bit unsigned integer.

Definition at line 13 of file UInt32.cs.

Member Function Documentation

◆ CompareTo() [1/2]

int System.UInt32.CompareTo ( object  value)

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

Parameters
valueAn object to compare, or null.
Returns
A signed number indicating the relative values of this instance and value .Return Value Description Less than zero This instance is less than value . Zero This instance is equal to value . Greater than zero This instance is greater than value .-or- value is null.
Exceptions
T:System.ArgumentExceptionvalue is not a T:System.UInt32.

Definition at line 31 of file UInt32.cs.

◆ CompareTo() [2/2]

int System.UInt32.CompareTo ( uint  value)

Compares this instance to a specified 32-bit unsigned integer and returns an indication of their relative values.

Parameters
valueAn unsigned integer to compare.
Returns
A signed number indicating the relative values of this instance and value .Return value Description Less than zero This instance is less than value . Zero This instance is equal to value . Greater than zero This instance is greater than value .

Definition at line 57 of file UInt32.cs.

◆ Equals() [1/2]

override bool System.UInt32.Equals ( object  obj)

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

Parameters
objAn object to compare with this instance.
Returns
true if obj is an instance of T:System.UInt32 and equals the value of this instance; otherwise, false.

Definition at line 75 of file UInt32.cs.

◆ Equals() [2/2]

bool System.UInt32.Equals ( uint  obj)

Returns a value indicating whether this instance is equal to a specified T:System.UInt32.

Parameters
objA value to compare to this instance.
Returns
true if obj has the same value as this instance; otherwise, false.

Definition at line 90 of file UInt32.cs.

◆ GetHashCode()

override int System.UInt32.GetHashCode ( )

Returns the hash code for this instance.

Returns
A 32-bit signed integer hash code.

Definition at line 98 of file UInt32.cs.

◆ GetTypeCode()

TypeCode System.UInt32.GetTypeCode ( )

Returns the T:System.TypeCode for value type T:System.UInt32.

Returns
The enumerated constant, F:System.TypeCode.UInt32.

Implements System.IConvertible.

Definition at line 252 of file UInt32.cs.

◆ Parse() [1/4]

static uint System.UInt32.Parse ( string  s)
static

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

Parameters
sA string representing the number to convert.
Returns
A 32-bit unsigned integer equivalent to the number contained in s .
Exceptions
T:System.ArgumentNullExceptionThe s parameter is null.
T:System.FormatExceptionThe s parameter is not of the correct format.
T:System.OverflowExceptionThe s parameter represents a number that is less than F:System.UInt32.MinValue or greater than F:System.UInt32.MaxValue.

Definition at line 153 of file UInt32.cs.

◆ Parse() [2/4]

static uint System.UInt32.Parse ( string  s,
NumberStyles  style 
)
static

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

Parameters
sA string representing the number to convert. The string is interpreted by using the style specified by the style parameter.
styleA bitwise combination of the enumeration values that specify the permitted format of s . A typical value to specify is F:System.Globalization.NumberStyles.Integer.
Returns
A 32-bit unsigned integer equivalent to the number specified in s .
Exceptions
T:System.ArgumentNullExceptions is null.
T:System.ArgumentExceptionstyle is not a T:System.Globalization.NumberStyles value. -or- style is not a combination of F:System.Globalization.NumberStyles.AllowHexSpecifier and F:System.Globalization.NumberStyles.HexNumber values.
T:System.FormatExceptions is not in a format compliant with style .
T:System.OverflowExceptions represents a number that is less than F:System.UInt32.MinValue or greater than F:System.UInt32.MaxValue. -or- s includes non-zero, fractional digits.

Definition at line 174 of file UInt32.cs.

◆ Parse() [3/4]

static uint System.UInt32.Parse ( string  s,
IFormatProvider  provider 
)
static

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

Parameters
sA string that represents the number to convert.
providerAn object that supplies culture-specific formatting information about s .
Returns
A 32-bit unsigned integer equivalent to the number specified in s .
Exceptions
T:System.ArgumentNullExceptions is null.
T:System.FormatExceptions is not in the correct style.
T:System.OverflowExceptions represents a number that is less than F:System.UInt32.MinValue or greater than F:System.UInt32.MaxValue.

Definition at line 192 of file UInt32.cs.

◆ Parse() [4/4]

static uint System.UInt32.Parse ( string  s,
NumberStyles  style,
IFormatProvider  provider 
)
static

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

Parameters
sA string representing the number to convert. The string is interpreted by using the style specified by the style parameter.
styleA bitwise combination of enumeration values that indicates the style elements that can be present in s . A typical value to specify is F:System.Globalization.NumberStyles.Integer.
providerAn object that supplies culture-specific formatting information about s .
Returns
A 32-bit unsigned integer equivalent to the number specified in s .
Exceptions
T:System.ArgumentNullExceptions is null.
T:System.ArgumentExceptionstyle is not a T:System.Globalization.NumberStyles value. -or- style is not a combination of F:System.Globalization.NumberStyles.AllowHexSpecifier and F:System.Globalization.NumberStyles.HexNumber values.
T:System.FormatExceptions is not in a format compliant with style .
T:System.OverflowExceptions represents a number that is less than F:System.UInt32.MinValue or greater than F:System.UInt32.MaxValue. -or- s includes non-zero, fractional digits.

Definition at line 214 of file UInt32.cs.

◆ ToBoolean()

bool IConvertible. System.UInt32.ToBoolean ( IFormatProvider  provider)

For a description of this member, see M:System.IConvertible.ToBoolean(System.IFormatProvider).

Parameters
providerThis parameter is ignored.
Returns
true if the value of the current instance is not zero; otherwise, false.

Implements System.IConvertible.

Definition at line 262 of file UInt32.cs.

◆ ToByte()

byte IConvertible. System.UInt32.ToByte ( IFormatProvider  provider)

For a description of this member, see M:System.IConvertible.ToByte(System.IFormatProvider).

Parameters
providerThis parameter is ignored.
Returns
The value of the current instance, converted to a T:System.Byte.

Implements System.IConvertible.

Definition at line 289 of file UInt32.cs.

◆ ToChar()

char IConvertible. System.UInt32.ToChar ( IFormatProvider  provider)

For a description of this member, see M:System.IConvertible.ToChar(System.IFormatProvider).

Parameters
providerThis parameter is ignored.
Returns
The value of the current instance, converted to a T:System.Char.

Implements System.IConvertible.

Definition at line 271 of file UInt32.cs.

◆ ToDateTime()

DateTime IConvertible. System.UInt32.ToDateTime ( IFormatProvider  provider)

This conversion is not supported. Attempting to use this method throws an T:System.InvalidCastException.

Parameters
providerThis parameter is ignored.
Returns
This conversion is not supported. No value is returned.
Exceptions
T:System.InvalidCastExceptionIn all cases.

Implements System.IConvertible.

Definition at line 380 of file UInt32.cs.

◆ ToDecimal()

decimal IConvertible. System.UInt32.ToDecimal ( IFormatProvider  provider)

For a description of this member, see M:System.IConvertible.ToDecimal(System.IFormatProvider).

Parameters
providerThis parameter is ignored.
Returns
The value of the current instance, converted to a T:System.Decimal.

Implements System.IConvertible.

Definition at line 370 of file UInt32.cs.

◆ ToDouble()

double IConvertible. System.UInt32.ToDouble ( IFormatProvider  provider)

For a description of this member, see M:System.IConvertible.ToDouble(System.IFormatProvider).

Parameters
providerThis parameter is ignored.
Returns
The value of the current instance, converted to a T:System.Double.

Implements System.IConvertible.

Definition at line 361 of file UInt32.cs.

◆ ToInt16()

short IConvertible. System.UInt32.ToInt16 ( IFormatProvider  provider)

For a description of this member, see M:System.IConvertible.ToInt16(System.IFormatProvider).

Parameters
providerThis parameter is ignored.
Returns
The value of the current instance, converted to an T:System.Int16.

Implements System.IConvertible.

Definition at line 298 of file UInt32.cs.

◆ ToInt32()

int IConvertible. System.UInt32.ToInt32 ( IFormatProvider  provider)

For a description of this member, see M:System.IConvertible.ToInt32(System.IFormatProvider).

Parameters
providerThis parameter is ignored.
Returns
The value of the current instance, converted to an T:System.Int32.

Implements System.IConvertible.

Definition at line 316 of file UInt32.cs.

◆ ToInt64()

long IConvertible. System.UInt32.ToInt64 ( IFormatProvider  provider)

For a description of this member, see M:System.IConvertible.ToInt64(System.IFormatProvider).

Parameters
providerThis parameter is ignored.
Returns
The value of the current instance, converted to an T:System.Int64.

Implements System.IConvertible.

Definition at line 334 of file UInt32.cs.

◆ ToSByte()

sbyte IConvertible. System.UInt32.ToSByte ( IFormatProvider  provider)

For a description of this member, see M:System.IConvertible.ToSByte(System.IFormatProvider).

Parameters
providerThis parameter is ignored.
Returns
The value of the current instance, converted to an T:System.SByte.

Implements System.IConvertible.

Definition at line 280 of file UInt32.cs.

◆ ToSingle()

float IConvertible. System.UInt32.ToSingle ( IFormatProvider  provider)

For a description of this member, see M:System.IConvertible.ToSingle(System.IFormatProvider).

Parameters
providerThis parameter is ignored.
Returns
The value of the current instance, converted to a T:System.Single.

Implements System.IConvertible.

Definition at line 352 of file UInt32.cs.

◆ ToString() [1/4]

override string System.UInt32.ToString ( )

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

Returns
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.

Definition at line 107 of file UInt32.cs.

◆ ToString() [2/4]

string System.UInt32.ToString ( IFormatProvider  provider)

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

Parameters
providerAn object that supplies culture-specific formatting information.
Returns
The string representation of the value of this instance, which consists of a sequence of digits ranging from 0 to 9, without a sign or leading zeros.

Implements System.IConvertible.

Definition at line 117 of file UInt32.cs.

◆ ToString() [3/4]

string System.UInt32.ToString ( string  format)

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

Parameters
formatA numeric format string.
Returns
The string representation of the value of this instance as specified by format .
Exceptions
T:System.FormatExceptionThe format parameter is invalid.

Definition at line 128 of file UInt32.cs.

◆ ToString() [4/4]

string System.UInt32.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.

Parameters
formatA numeric format string.
providerAn object that supplies culture-specific formatting information about this instance.
Returns
The string representation of the value of this instance as specified by format and provider .
Exceptions
T:System.FormatExceptionThe format parameter is invalid.

Implements System.IFormattable.

Definition at line 140 of file UInt32.cs.

◆ ToType()

object IConvertible. System.UInt32.ToType ( Type  type,
IFormatProvider  provider 
)

For a description of this member, see M:System.IConvertible.ToType(System.Type,System.IFormatProvider).

Parameters
typeThe type to which to convert this T:System.UInt32 value.
providerAn T:System.IFormatProvider implementation that supplies culture-specific information about the format of the returned value.
Returns
The value of the current instance, converted to type .

Implements System.IConvertible.

Definition at line 390 of file UInt32.cs.

◆ ToUInt16()

ushort IConvertible. System.UInt32.ToUInt16 ( IFormatProvider  provider)

For a description of this member, see M:System.IConvertible.ToUInt16(System.IFormatProvider).

Parameters
providerThis parameter is ignored.
Returns
The value of the current instance, converted to a T:System.UInt16.

Implements System.IConvertible.

Definition at line 307 of file UInt32.cs.

◆ ToUInt32()

uint IConvertible. System.UInt32.ToUInt32 ( IFormatProvider  provider)

For a description of this member, see M:System.IConvertible.ToUInt32(System.IFormatProvider).

Parameters
providerThis parameter is ignored.
Returns
The value of the current instance, unchanged.

Implements System.IConvertible.

Definition at line 325 of file UInt32.cs.

◆ ToUInt64()

ulong IConvertible. System.UInt32.ToUInt64 ( IFormatProvider  provider)

For a description of this member, see M:System.IConvertible.ToUInt64(System.IFormatProvider).

Parameters
providerThis parameter is ignored.
Returns
The value of the current instance, converted to a T:System.UInt64.

Implements System.IConvertible.

Definition at line 343 of file UInt32.cs.

◆ TryParse() [1/2]

static bool System.UInt32.TryParse ( string  s,
out uint  result 
)
static

Tries to convert the string representation of a number to its 32-bit unsigned integer equivalent. A return value indicates whether the conversion succeeded or failed.

Parameters
sA string that represents the number to convert.
resultWhen this method returns, contains the 32-bit unsigned integer value that is equivalent to the number contained in s , if the conversion succeeded, or zero if the conversion failed. The conversion fails if the s parameter is null or F:System.String.Empty, is not of the correct format, or represents a number that is less than F:System.UInt32.MinValue or greater than F:System.UInt32.MaxValue. This parameter is passed uninitialized; any value originally supplied in result will be overwritten.
Returns
true if s was converted successfully; otherwise, false.

Definition at line 227 of file UInt32.cs.

◆ TryParse() [2/2]

static bool System.UInt32.TryParse ( string  s,
NumberStyles  style,
IFormatProvider  provider,
out uint  result 
)
static

Tries to convert the string representation of a number in a specified style and culture-specific format to its 32-bit unsigned integer equivalent. A return value indicates whether the conversion succeeded or failed.

Parameters
sA string that represents the number to convert. The string is interpreted by using the style specified by the style parameter.
styleA bitwise combination of enumeration values that indicates the permitted format of s . A typical value to specify is F:System.Globalization.NumberStyles.Integer.
providerAn object that supplies culture-specific formatting information about s .
resultWhen this method returns, contains the 32-bit unsigned integer value equivalent to the number contained in s , if the conversion succeeded, or zero if the conversion failed. The conversion fails if the s parameter is null or F:System.String.Empty, is not in a format compliant with style , or represents a number that is less than F:System.UInt32.MinValue or greater than F:System.UInt32.MaxValue. This parameter is passed uninitialized; any value originally supplied in result will be overwritten.
Returns
true if s was converted successfully; otherwise, false.
Exceptions
T:System.ArgumentExceptionstyle is not a T:System.Globalization.NumberStyles value. -or- style is not a combination of F:System.Globalization.NumberStyles.AllowHexSpecifier and F:System.Globalization.NumberStyles.HexNumber values.

Definition at line 244 of file UInt32.cs.

Member Data Documentation

◆ MaxValue

const uint System.UInt32.MaxValue = 4294967295u

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

Definition at line 19 of file UInt32.cs.

◆ MinValue

const uint System.UInt32.MinValue = 0u

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

Definition at line 23 of file UInt32.cs.


The documentation for this struct was generated from the following file: