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

Represents a 32-bit signed integer.To browse the .NET Framework source code for this type, see the Reference Source. More...

Inheritance diagram for System.Int32:
[legend]
Collaboration diagram for System.Int32:
[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 (int value)
 Compares this instance to a specified 32-bit signed 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 (int obj)
 Returns a value indicating whether this instance is equal to a specified T:System.Int32 value. 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 (string format)
 Converts the numeric value of this instance to its equivalent string representation, using the specified format. 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, 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.Int32. 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< int >
bool Equals (T other)
 Indicates whether the current object is equal to another object of the same type. More...
 

Static Public Member Functions

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

Public Attributes

internal int m_value
 
const int MaxValue = 2147483647
 Represents the largest possible value of an T:System.Int32. This field is constant. More...
 
const int MinValue = -2147483648
 Represents the smallest possible value of T:System.Int32. This field is constant. More...
 

Detailed Description

Represents a 32-bit signed integer.To browse the .NET Framework source code for this type, see the Reference Source.

Definition at line 12 of file Int32.cs.

Member Function Documentation

◆ CompareTo() [1/2]

int System.Int32.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 an T:System.Int32.

Definition at line 30 of file Int32.cs.

◆ CompareTo() [2/2]

int System.Int32.CompareTo ( int  value)

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

Parameters
valueAn 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 56 of file Int32.cs.

◆ Equals() [1/2]

override bool System.Int32.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.Int32 and equals the value of this instance; otherwise, false.

Definition at line 74 of file Int32.cs.

◆ Equals() [2/2]

bool System.Int32.Equals ( int  obj)

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

Parameters
objAn T:System.Int32 value to compare to this instance.
Returns
true if obj has the same value as this instance; otherwise, false.

Definition at line 89 of file Int32.cs.

◆ GetHashCode()

override int System.Int32.GetHashCode ( )

Returns the hash code for this instance.

Returns
A 32-bit signed integer hash code.

Definition at line 97 of file Int32.cs.

◆ GetTypeCode()

TypeCode System.Int32.GetTypeCode ( )

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

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

Implements System.IConvertible.

Definition at line 250 of file Int32.cs.

◆ Parse() [1/4]

static int System.Int32.Parse ( string  s)
static

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

Parameters
sA string containing a number to convert.
Returns
A 32-bit signed integer equivalent to the number contained in s .
Exceptions
T:System.ArgumentNullExceptions is null.
T:System.FormatExceptions is not in the correct format.
T:System.OverflowExceptions represents a number less than F:System.Int32.MinValue or greater than F:System.Int32.MaxValue.

Definition at line 156 of file Int32.cs.

◆ Parse() [2/4]

static int System.Int32.Parse ( string  s,
NumberStyles  style 
)
static

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

Parameters
sA string containing a number to convert.
styleA bitwise combination of the enumeration values that indicates the style elements that can be present in s . A typical value to specify is F:System.Globalization.NumberStyles.Integer.
Returns
A 32-bit signed 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 less than F:System.Int32.MinValue or greater than F:System.Int32.MaxValue. -or- s includes non-zero, fractional digits.

Definition at line 176 of file Int32.cs.

◆ Parse() [3/4]

static int System.Int32.Parse ( string  s,
IFormatProvider  provider 
)
static

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

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

Definition at line 193 of file Int32.cs.

◆ Parse() [4/4]

static int System.Int32.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 signed integer equivalent.

Parameters
sA string containing a number to convert.
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 information about the format of s .
Returns
A 32-bit signed 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 less than F:System.Int32.MinValue or greater than F:System.Int32.MaxValue. -or- s includes non-zero, fractional digits.

Definition at line 214 of file Int32.cs.

◆ ToBoolean()

bool IConvertible. System.Int32.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 260 of file Int32.cs.

◆ ToByte()

byte IConvertible. System.Int32.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 287 of file Int32.cs.

◆ ToChar()

char IConvertible. System.Int32.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 269 of file Int32.cs.

◆ ToDateTime()

DateTime IConvertible. System.Int32.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 378 of file Int32.cs.

◆ ToDecimal()

decimal IConvertible. System.Int32.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 368 of file Int32.cs.

◆ ToDouble()

double IConvertible. System.Int32.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 359 of file Int32.cs.

◆ ToInt16()

short IConvertible. System.Int32.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 296 of file Int32.cs.

◆ ToInt32()

int IConvertible. System.Int32.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, unchanged.

Implements System.IConvertible.

Definition at line 314 of file Int32.cs.

◆ ToInt64()

long IConvertible. System.Int32.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 332 of file Int32.cs.

◆ ToSByte()

sbyte IConvertible. System.Int32.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 278 of file Int32.cs.

◆ ToSingle()

float IConvertible. System.Int32.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 350 of file Int32.cs.

◆ ToString() [1/4]

override string System.Int32.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 negative sign if the value is negative, and a sequence of digits ranging from 0 to 9 with no leading zeroes.

Definition at line 106 of file Int32.cs.

◆ ToString() [2/4]

string System.Int32.ToString ( string  format)

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

Parameters
formatA standard or custom numeric format string.
Returns
The string representation of the value of this instance as specified by format .
Exceptions
T:System.FormatExceptionformat is invalid or not supported.

Definition at line 118 of file Int32.cs.

◆ ToString() [3/4]

string System.Int32.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 as specified by provider .

Implements System.IConvertible.

Definition at line 128 of file Int32.cs.

◆ ToString() [4/4]

string System.Int32.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 standard or custom numeric format string.
providerAn object that supplies culture-specific formatting information.
Returns
The string representation of the value of this instance as specified by format and provider .
Exceptions
T:System.FormatExceptionformat is invalid or not supported.

Implements System.IFormattable.

Definition at line 141 of file Int32.cs.

◆ ToType()

object IConvertible. System.Int32.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.Int32 value.
providerAn object that provides information about the format of the returned value.
Returns
The value of the current instance, converted to type .

Implements System.IConvertible.

Definition at line 388 of file Int32.cs.

◆ ToUInt16()

ushort IConvertible. System.Int32.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 305 of file Int32.cs.

◆ ToUInt32()

uint IConvertible. System.Int32.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, converted to a T:System.UInt32.

Implements System.IConvertible.

Definition at line 323 of file Int32.cs.

◆ ToUInt64()

ulong IConvertible. System.Int32.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 341 of file Int32.cs.

◆ TryParse() [1/2]

static bool System.Int32.TryParse ( string  s,
out int  result 
)
static

Converts the string representation of a number to its 32-bit signed integer equivalent. A return value indicates whether the conversion succeeded.

Parameters
sA string containing a number to convert.
resultWhen this method returns, contains the 32-bit signed integer value equivalent of 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 less than F:System.Int32.MinValue or greater than F:System.Int32.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 226 of file Int32.cs.

◆ TryParse() [2/2]

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

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

Parameters
sA string containing a number to convert. The string is interpreted using the style specified by style .
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 .
resultWhen this method returns, contains the 32-bit signed integer value equivalent of 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 less than F:System.Int32.MinValue or greater than F:System.Int32.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 242 of file Int32.cs.

Member Data Documentation

◆ MaxValue

const int System.Int32.MaxValue = 2147483647

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

Definition at line 18 of file Int32.cs.

◆ MinValue

const int System.Int32.MinValue = -2147483648

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

Definition at line 22 of file Int32.cs.


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