Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object.
Declaration Syntax
C# | Visual Basic | Visual C++ | F# |
public int CompareTo( Object obj )
Public Function CompareTo ( obj As Object ) As Integer
public: virtual int CompareTo( Object^ obj ) sealed
abstract CompareTo : obj : Object -> int override CompareTo : obj : Object -> int
Parameters
- obj (Object)
- An object to compare with this instance.
Return Value
Int32
A 32-bit signed integer that indicates the relative order of the objects being compared. The return value has these meanings: Value Meaning Less than zero This instance precedes obj in the sort order. Zero This instance occurs in the same position in the sort order as obj. Greater than zero This instance follows obj in the sort order.
A 32-bit signed integer that indicates the relative order of the objects being compared. The return value has these meanings: Value Meaning Less than zero This instance precedes obj in the sort order. Zero This instance occurs in the same position in the sort order as obj. Greater than zero This instance follows obj in the sort order.
Exceptions
Exception | Condition |
---|---|
ArgumentException | obj is not the same type as this instance. |
Assembly: SwiPlCs (Module: SwiPlCs.dll) Version: 1.1.60601.0 (1.1.60601.0)