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)

Syntax

'Declaration
Public Function CompareTo ( _
    value As Object _
) As Integer
public int CompareTo(
    Object value
)

Parameters

  • value
    Type: System.Object
    An object to compare, or nulla null reference (Nothing in Visual Basic).

Return Value

Type: System.Int32
A signed integer that indicates the relationship of this instance to 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 nulla null reference (Nothing in Visual Basic).

Implements

IComparable.CompareTo(Object)

Exceptions

Exception Condition
ArgumentException

value is not a Byte.

Remarks

value must be nulla null reference (Nothing in Visual Basic) or an instance of Byte; otherwise, an exception is thrown.

Any instance of Byte, regardless of its value, is considered greater than nulla null reference (Nothing in Visual Basic).

This method is implemented to support the IComparable interface.

Examples

The following code example demonstrates the CompareTo method.

Public Sub Compare(ByVal outputBlock As System.Windows.Controls.TextBlock, ByVal myByte As [Byte])
   Dim myCompareResult As Integer

   myCompareResult = MemberByte.CompareTo(myByte)

   If myCompareResult > 0 Then
      outputBlock.Text += String.Format("{0} is less than the MemberByte value {1}", myByte.ToString(), MemberByte.ToString()) & vbCrLf
   Else
      If myCompareResult < 0 Then
         outputBlock.Text += String.Format("{0} is greater than the MemberByte value {1}", myByte.ToString(), MemberByte.ToString()) & vbCrLf
      Else
         outputBlock.Text += String.Format("{0} is equal to the MemberByte value {1}", myByte.ToString(), MemberByte.ToString()) & vbCrLf
      End If
   End If
End Sub 'Compare 
public void Compare(System.Windows.Controls.TextBlock outputBlock, Byte myByte)
{
   int myCompareResult;

   myCompareResult = MemberByte.CompareTo(myByte);

   if (myCompareResult > 0)
   {
      outputBlock.Text += String.Format("{0} is less than the MemberByte value {1}", myByte.ToString(), MemberByte.ToString()) + "\n";
   }
   else if (myCompareResult < 0)
   {
      outputBlock.Text += String.Format("{0} is greater than the MemberByte value {1}", myByte.ToString(), MemberByte.ToString()) + "\n";
   }
   else
   {
      outputBlock.Text += String.Format("{0} is equal to the MemberByte value {1}", myByte.ToString(), MemberByte.ToString()) + "\n";
   }
}

Version Information

Silverlight

Supported in: 5, 4, 3

Silverlight for Windows Phone

Supported in: Windows Phone OS 7.1, Windows Phone OS 7.0

XNA Framework

Supported in: Xbox 360, Windows Phone OS 7.0

Platforms

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.