BigInteger::CompareTo Method (Object^)

.NET Framework (current version)

Compares this instance to a specified object and returns an integer that indicates whether the value of this instance is less than, equal to, or greater than the value of the specified object.

Namespace: System.Numerics
Assembly: System.Numerics (in System.Numerics.dll)

Syntax

C++

public:
virtual int CompareTo(
	Object^ obj
) sealed

Parameters

obj: Type: System::Object^
The object to compare.

Return Value

Type: System::Int32

A signed integer that indicates the relationship of the current instance to the obj parameter, as shown in the following table.

Return value	Description
Less than zero	The current instance is less than obj.
Zero	The current instance equals obj.
Greater than zero	The current instance is greater than obj, or the obj parameter is null.

Implements

IComparable::CompareTo(Object^)

Exceptions

Exception	Condition
ArgumentException	obj is not a BigInteger.

Remarks

This overload of the CompareTo method implements the IComparable::CompareTo method. It is used by non-generic collection objects to order the items in the collection.

The obj parameter must be one of the following:

An object whose run-time type is BigInteger.
An Object variable whose value is null. If the value of the obj parameter is null, the method returns 1, which indicates that that the current instance is greater than obj.

Examples

The following example calls the CompareTo(Object^) method to compare a BigInteger value with each element in an object array

C++

No code example is currently available or this language may not be supported.

Version Information

.NET Framework
Available since 4.0
Silverlight
Available since 4.0