System.Int32 Structure

Assembly: Mscorlib.dll
Namespace: System
Summary
Represents a 32-bit signed integer.
C# Syntax:
[Serializable]
public struct Int32 : IComparable, IFormattable, IConvertible
Thread Safety
This type is safe for multithreaded operations.
Remarks
The Int32 value type represents signed integers with values ranging from negative 2,147,483,648 through positive 2,147,483,647.

Int32 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.
See also:
System Namespace | UInt32

System.Int32 Member List:

Public Fields
MaxValue Represents the largest possible value of an Int32. This field is constant.
MinValue Represents the smallest possible value of Int32. 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 Int32.
Parse Overloaded:
Parse(string s)

Converts the string representation of a number to its 32-bit signed 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 signed integer equivalent.
Parse Overloaded:
Parse(string s, NumberStyles style)

Converts the string representation of a number in a specified style to its 32-bit signed 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 signed 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.Int32 Member Details

Field: MaxValue
Summary
Represents the largest possible value of an Int32. This field is constant.
C# Syntax:
public const int MaxValue;
Remarks
The value of this constant is 2,147,483,647; that is, hexadecimal 0x7FFFFFFF.
See also:
Int32.MinValue

Return to top


Field: MinValue
Summary
Represents the smallest possible value of Int32. This field is constant.
C# Syntax:
public const int MinValue;
Remarks
The value of this constant is -2,147,483,648; that is, hexadecimal 0x80000000.
See also:
Int32.MaxValue

Return to top


Method: CompareTo(
   object value
)
Summary
Compares this instance to a specified object and returns an indication of their relative values.
C# Syntax:
public int CompareTo(
   object value
);
Parameters:

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 an Int32 or null.
Remarks
Any instance of Int32, regardless of its value, is considered greater than null.value must be null or an instance of Int32; otherwise, an exception is thrown.
See also:
UInt32 | Int32.Equals

Return to top


Overridden Method: Equals(
   object obj
)
Summary
Returns a value indicating whether this instance is equal to a specified object.
C# Syntax:
public override bool Equals(
   object obj
);
Parameters:

obj

An object to compare with this instance.

Return Value:
true if obj is an instance of Int32 and equals the value of this instance; otherwise, false.
Example
The following sample demonstrates the Int32.Equals method.
            Int32 myVariable1 = 60;
            Int32 myVariable2 = 60;

            // Get and 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");
            

    
See also:
Int32.CompareTo

Return to top


Method: Finalize()
Inherited
See base class member description: System.Object.Finalize
C# Syntax:
~Int32();

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

Return to top


Overridden Method: GetHashCode()
Summary
Returns the hash code for this instance.
C# Syntax:
public override int GetHashCode();
Return Value:
A 32-bit signed integer hash code.

Return to top


Method: GetType()
Inherited
See base class member description: System.Object.GetType
C# Syntax:
public Type GetType();

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

Return to top


Method: GetTypeCode()
Summary
Returns the TypeCode for value type Int32.
C# Syntax:
public TypeCode GetTypeCode();
Return Value:
The enumerated constant, TypeCode.Int32.
See also:
TypeCode

Return to top


Method: MemberwiseClone()
Inherited
See base class member description: System.Object.MemberwiseClone
C# Syntax:
protected object MemberwiseClone();

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

Return to top


Overloaded Method: Parse(
   string s
)
Summary
Converts the string representation of a number to its 32-bit signed integer equivalent.
C# Syntax:
public static int Parse(
   string s
);
Parameters:

s

A string containing a number to convert.

Return Value:
A 32-bit signed integer equivalent to the number contained in s.
Exceptions
Exception Type Condition
ArgumentNullException s is null.
FormatException s does not consist solely of an optional negative sign followed by a sequence of digits ranging from 0 to 9.
OverflowException s represents a number less than Int32.MinValue or greater than Int32.MaxValue.
Remarks
The s parameter contains a number of the form:

[ws][sign]digits[ws]

Items in square brackets ([ and ]) are optional; and the values of the other items are as follows.

ws An optional white space. sign An optional 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.

See also:
MSDN: formattingoverview | Int32.ToString

Return to top


Overloaded Method: Parse(
   string s,
   IFormatProvider provider
)
Summary
Converts the string representation of a number in a specified culture-specific format to its 32-bit signed integer equivalent.
C# Syntax:
public static int Parse(
   string s,
   IFormatProvider provider
);
Parameters:

s

A string containing a number to convert.

provider

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

Return Value:
A 32-bit signed integer equivalent to the number specified in s.
Exceptions
Exception Type Condition
ArgumentNullException s is null.
OverflowException s represents a number less than Int32.MinValue or greater than Int32.MaxValue.
Remarks
The s parameter contains a number of the form:

[ws][sign]digits[ws]

Items in square brackets ([ and ]) are optional; and the values of the other items are as follows.

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

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

See also:
MSDN: formattingoverview | Int32.ToString

Return to top


Overloaded Method: Parse(
   string s,
   NumberStyles style
)
Summary
Converts the string representation of a number in a specified style to its 32-bit signed integer equivalent.
C# Syntax:
public static int Parse(
   string s,
   NumberStyles style
);
Parameters:

s

A string containing a number to convert.

style

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

Return Value:
A 32-bit signed 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 Int32.MinValue or greater than Int32.MaxValue.
Remarks
The s parameter contains a number of the form:

[ws][sign]digits[ws]

Items in square brackets ([ and ]) are optional; and the values of the other items are as follows.

ws An optional white space. sign An optional 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).

See also:
MSDN: formattingoverview | Int32.ToString

Return to top


Overloaded Method: Parse(
   string s,
   NumberStyles style,
   IFormatProvider provider
)
Summary
Converts the string representation of a number in a specified style and culture-specific format to its 32-bit signed integer equivalent.
C# Syntax:
public static int Parse(
   string s,
   NumberStyles style,
   IFormatProvider provider
);
Parameters:

s

A string containing a number to convert.

style

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

provider

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

Return Value:
A 32-bit signed 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 Int32.MinValue or greater than Int32.MaxValue.
Remarks
The s parameter contains a number of the form:

[ws][sign]digits[ws]

Items in square brackets ([ and ]) are optional; and the values of the other items are as follows. ws An optional white space. sign An optional 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 object. The NumberFormatInfo provides culture-specific information about the format of s. If provider is null, the NumberFormatInfo for the current culture is used.

See also:
MSDN: formattingoverview | Int32.ToString

Return to top


Overloaded Method: ToString()
Summary
Converts the numeric value of this instance to its equivalent string representation.
C# Syntax:
public override string ToString();
Return Value:
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.
Remarks
The return value is formatted with the general format specifier ("G") and the NumberFormatInfo for the current culture.
See also:
MSDN: formattingoverview | Int32.Parse | String

Return to top


Overloaded Method: ToString(
   IFormatProvider provider
)
Summary
Converts the numeric value of this instance to its equivalent string representation using the specified culture-specific format information.
C# Syntax:
public string ToString(
   IFormatProvider provider
);
Parameters:

provider

An IFormatProvider that supplies culture-specific formatting information.

Return Value:
The string representation of the value of this instance as specified by provider.
Remarks
This instance is formatted with the general format specifier ("G").

provider is an IFormatProvider that obtains a NumberFormatInfo object. 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.

See also:
MSDN: formattingoverview | Int32.Parse | String

Return to top


Overloaded Method: ToString(
   string format
)
Summary
Converts the numeric value of this instance to its equivalent string representation, using the specified format.
C# Syntax:
public string ToString(
   string format
);
Parameters:

format

A format string.

Return Value:
The string representation of the value of this instance as specified by format.
Remarks
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.

See also:
MSDN: formattingoverview | Int32.Parse | String

Return to top


Overloaded Method: ToString(
   string format,
   IFormatProvider provider
)
Summary
Converts the numeric value of this instance to its equivalent string representation using the specified format and culture-specific format information.
C# Syntax:
public string ToString(
   string format,
   IFormatProvider provider
);
Parameters:

format

A format specification.

provider

An IFormatProvider that supplies culture-specific formatting information.

Return Value:
The string representation of the value of this instance as specified by format and provider.
Remarks
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 object. 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.

See also:
MSDN: formattingoverview | Int32.Parse | String

Return to top


Top of page

Copyright (c) 2002 Microsoft Corporation. All rights reserved.