CompareTo Method (Object)
Collapse the table of content
Expand the table of content

Byte.CompareTo Method (Object)

 

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

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

public int CompareTo(
	object value
)

Parameters

value
Type: System.Object

An object to compare, or null.

Return Value

Type: System.Int32

A signed integer that indicates the relative order 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.

Exception Condition
ArgumentException

value is not a Byte.

value must be null or an instance of Byte; otherwise, an exception is thrown.

Any instance of Byte, regardless of its value, is considered greater than null.

This method is implemented to support the IComparable interface.

The following code example demonstrates the CompareTo method.

public void Compare(Byte myByte)
{
   int myCompareResult;

   myCompareResult = MemberByte.CompareTo(myByte);

   if(myCompareResult > 0)
   {
      Console.WriteLine("{0} is less than the MemberByte value {1}", myByte.ToString(), MemberByte.ToString());
   }
   else if(myCompareResult < 0)
   {
      Console.WriteLine("{0} is greater than the MemberByte value {1}", myByte.ToString(), MemberByte.ToString());
   }
   else
   {
      Console.WriteLine("{0} is equal to the MemberByte value {1}", myByte.ToString(), MemberByte.ToString());
   }
}

.NET Framework
Available since 1.1
Silverlight
Available since 2.0
Windows Phone Silverlight
Available since 7.0
Return to top
Show:
© 2016 Microsoft