DateTime.CompareTo Метод

Определение

Сравнивает значение данного экземпляра с заданным значением DateTime и указывает, когда наступает момент, заданный в данном экземпляре: раньше, позже или одновременно с моментом, заданным значением DateTime.Compares the value of this instance to a specified DateTime value and indicates whether this instance is earlier than, the same as, or later than the specified DateTime value.

Перегрузки

CompareTo(DateTime)

Сравнивает значение данного экземпляра с заданным значением DateTime и возвращает целочисленное значение, указывающее, когда наступает момент, заданный в данном экземпляре: раньше, позже или одновременно с моментом, заданным значением DateTime.Compares the value of this instance to a specified DateTime value and returns an integer that indicates whether this instance is earlier than, the same as, or later than the specified DateTime value.

CompareTo(Object)

Сравнивает значение данного экземпляра с заданным объектом, содержащим заданное значение DateTime, и возвращает целочисленное значение, указывающее, когда наступает момент, заданный в данном экземпляре: раньше, позже или одновременно с моментом, заданным значением DateTime.Compares the value of this instance to a specified object that contains a specified DateTime value, and returns an integer that indicates whether this instance is earlier than, the same as, or later than the specified DateTime value.

Комментарии

Две перегрузки метода CompareTo возвращают число со знаком, которое указывает относительное значение данного экземпляра и аргумента value, как показано в следующей таблице.The two overloads of the CompareTo method return a signed number that indicates the relative value of this instance and the value argument, as shown in the following table.

ЗначениеValue ОписаниеDescription
Меньше нуляLess than zero Данный экземпляр раньше value.This instance is earlier than value.
НульZero Данный экземпляр равен value.This instance is the same as value.
Больше нуляGreater than zero Этот экземпляр позже value.This instance is later than value.

CompareTo(DateTime)

Сравнивает значение данного экземпляра с заданным значением DateTime и возвращает целочисленное значение, указывающее, когда наступает момент, заданный в данном экземпляре: раньше, позже или одновременно с моментом, заданным значением DateTime.Compares the value of this instance to a specified DateTime value and returns an integer that indicates whether this instance is earlier than, the same as, or later than the specified DateTime value.

public:
 virtual int CompareTo(DateTime value);
public int CompareTo (DateTime value);
abstract member CompareTo : DateTime -> int
override this.CompareTo : DateTime -> int
Public Function CompareTo (value As DateTime) As Integer

Параметры

value
DateTime

Объект, сравниваемый с текущим экземпляром.The object to compare to the current instance.

Возвращаемое значение

Число со знаком, представляющее результат сравнения значений этого экземпляра и параметра value.A signed number indicating the relative values of this instance and the value parameter.

ЗначениеValue ОписаниеDescription
Меньше нуляLess than zero Данный экземпляр раньше value.This instance is earlier than value.
НульZero Данный экземпляр равен value.This instance is the same as value.
Больше нуляGreater than zero Этот экземпляр позже value.This instance is later than value.

Реализации

Примеры

В следующем примере создаются три объекта DateTime, один из которых представляет сегодняшнюю дату, второй представляет дату в прошлом году, а третий — дату на один год в будущем.The following example instantiates three DateTime objects, one that represents today's date, another that represents the date one year previously, and a third that represents the date one year in the future. Затем он вызывает метод CompareTo(DateTime) и отображает результат сравнения.It then calls the CompareTo(DateTime) method and displays the result of the comparison.

using System;

public class DateTimeComparison
{
   private enum DateComparisonResult
   {
      Earlier = -1,
      Later = 1,
      TheSame = 0
   };

   public static void Main()
   {
      DateTime thisDate = DateTime.Today;

      // Define two DateTime objects for today's date 
      // next year and last year		
      DateTime thisDateNextYear, thisDateLastYear;

      // Call AddYears instance method to add/substract 1 year
      thisDateNextYear = thisDate.AddYears(1);
      thisDateLastYear = thisDate.AddYears(-1);   

      // Compare dates
      //
      DateComparisonResult comparison;
      // Compare today to last year
      comparison = (DateComparisonResult) thisDate.CompareTo(thisDateLastYear);
      Console.WriteLine("CompareTo method returns {0}: {1:d} is {2} than {3:d}", 
                        (int) comparison, thisDate, comparison.ToString().ToLower(), 
                        thisDateLastYear);
      
      // Compare today to next year
      comparison = (DateComparisonResult) thisDate.CompareTo(thisDateNextYear);
      Console.WriteLine("CompareTo method returns {0}: {1:d} is {2} than {3:d}", 
                        (int) comparison, thisDate, comparison.ToString().ToLower(), 
                        thisDateNextYear);
   }
}
//
// If run on October 20, 2006, the example produces the following output:
//    CompareTo method returns 1: 10/20/2006 is later than 10/20/2005
//    CompareTo method returns -1: 10/20/2006 is earlier than 10/20/2007
Option Strict On

Module DateTimeComparison
   Private Enum DateComparisonResult
      Earlier = -1
      Later = 1
      TheSame = 0
   End Enum
   
   Public Sub Main()

      Dim thisDate As Date = Date.Today

      ' Define two DateTime objects for today's date 
      ' next year and last year		
      Dim thisDateNextYear, thisDateLastYear As Date

      ' Call AddYears instance method to add/substract 1 year
      thisDateNextYear = thisDate.AddYears(1)
      thisDateLastYear = thisDate.AddYears(-1)   

       
      ' Compare dates
      '
      Dim comparison As DateComparisonResult
      ' Compare today to last year
      comparison = CType(thisDate.CompareTo(thisDateLastYear), DateComparisonResult)
      Console.WriteLine("CompareTo method returns {0}: {1:d} is {2} than {3:d}", _ 
                        CInt(comparison), thisDate, comparison.ToString().ToLower(), _ 
                        thisDateLastYear)
      
      ' Compare today to next year
      comparison = CType(thisDate.CompareTo(thisDateNextYear), DateComparisonResult)
      Console.WriteLine("CompareTo method returns {0}: {1:d} is {2} than {3:d}", _
                        CInt(comparison), thisDate, comparison.ToString().ToLower(), _
                        thisDateNextYear)
   End Sub
End Module
'
' If run on October 20, 2006, the example produces the following output:
'    CompareTo method returns 1: 10/20/2006 is later than 10/20/2005
'    CompareTo method returns -1: 10/20/2006 is earlier than 10/20/2007

Комментарии

Чтобы определить связь текущего экземпляра с value, метод CompareTo сравнивает свойство Ticks текущего экземпляра и value, но игнорирует их свойство Kind.To determine the relationship of the current instance to value, the CompareTo method compares the Ticks property of the current instance and value but ignores their Kind property. Перед сравнением объектов DateTime убедитесь, что они представляют время в одном часовом поясе.Before comparing DateTime objects, make sure that the objects represent times in the same time zone. Это можно сделать, сравнив значения их свойств Kind.You can do this by comparing the values of their Kind properties.

Этот метод реализует интерфейс System.IComparable<T> и работает немного лучше, чем перегрузка метода DateTime.CompareTo(Object), поскольку ему не нужно преобразовывать параметр value в объект.This method implements the System.IComparable<T> interface and performs slightly better than the DateTime.CompareTo(Object) method overload because it does not have to convert the value parameter to an object.

Дополнительно

CompareTo(Object)

Сравнивает значение данного экземпляра с заданным объектом, содержащим заданное значение DateTime, и возвращает целочисленное значение, указывающее, когда наступает момент, заданный в данном экземпляре: раньше, позже или одновременно с моментом, заданным значением DateTime.Compares the value of this instance to a specified object that contains a specified DateTime value, and returns an integer that indicates whether this instance is earlier than, the same as, or later than the specified DateTime value.

public:
 int CompareTo(System::Object ^ value);
public:
 virtual int CompareTo(System::Object ^ value);
public int CompareTo (object value);
member this.CompareTo : obj -> int
abstract member CompareTo : obj -> int
override this.CompareTo : obj -> int
Public Function CompareTo (value As Object) As Integer

Параметры

value
Object

Сравниваемый упакованный объект или значение null.A boxed object to compare, or null.

Возвращаемое значение

Число со знаком, представляющее относительные значения этого экземпляра и параметра value.A signed number indicating the relative values of this instance and value.

ЗначениеValue ОписаниеDescription
Меньше нуляLess than zero Данный экземпляр раньше value.This instance is earlier than value.
НульZero Данный экземпляр равен value.This instance is the same as value.
Больше нуляGreater than zero Этот экземпляр позже value, или параметр value имеет значение null.This instance is later than value, or value is null.

Реализации

Исключения

value не является объектом типа DateTime.value is not a DateTime.

Примеры

В следующем примере демонстрируется метод CompareTo.The following example demonstrates the CompareTo method.

using namespace System;
void main()
{
   

   System::DateTime theDay(System::DateTime::Today.Year,7,28);
   int compareValue;
   try
   {
      compareValue = theDay.CompareTo( System::DateTime::Today );
   }
   catch ( ArgumentException^ ) 
   {
      System::Console::WriteLine( "Value is not a DateTime" );
      return;
   }

   if ( compareValue < 0 )
   {
      System::Console::WriteLine( "{0:d} is in the past.", theDay );
   }
   else
   if ( compareValue == 0 )
   {
      System::Console::WriteLine( "{0:d} is today!", theDay );
   }
   else
   // compareValue > 0 
   {
      System::Console::WriteLine( "{0:d} has not come yet.", theDay );
   }
}
System.DateTime theDay = new System.DateTime(System.DateTime.Today.Year, 7, 28);
int compareValue;

try 
{
    compareValue = theDay.CompareTo(DateTime.Today);
} 
catch (ArgumentException) 
{
   Console.WriteLine("Value is not a DateTime");
   return;
}

if (compareValue < 0) 
   System.Console.WriteLine("{0:d} is in the past.", theDay);
else if (compareValue == 0) 
   System.Console.WriteLine("{0:d} is today!", theDay);
else // compareValue > 0
   System.Console.WriteLine("{0:d} has not come yet.", theDay);
Dim thDay As New System.DateTime(System.DateTime.Today.Year, 7, 28)

Dim compareValue As Integer
Try
   compareValue = thDay.CompareTo(System.DateTime.Today)
Catch exp As ArgumentException
   System.Console.WriteLine("Value is not a DateTime")
End Try

If compareValue < 0 Then
   System.Console.WriteLine("{0:d} is in the past.", thDay)
ElseIf compareValue = 0 Then
   System.Console.WriteLine("{0:d} is today!", thDay)
Else   ' compareValue >= 1 
   System.Console.WriteLine("{0:d} has not come yet.", thDay)
End If

Комментарии

Чтобы определить связь текущего экземпляра с value, метод CompareTo сравнивает свойство Ticks текущего экземпляра и value, но игнорирует их свойство Kind.To determine the relationship of the current instance to value, the CompareTo method compares the Ticks property of the current instance and value but ignores their Kind property. Перед сравнением объектов DateTime убедитесь, что они представляют время в одном часовом поясе.Before comparing DateTime objects, make sure that the objects represent times in the same time zone. Это можно сделать, сравнив значения их свойств Kind.You can do this by comparing the values of their Kind properties.

Любой экземпляр DateTime, независимо от его значения, считается больше null.Any instance of DateTime, regardless of its value, is considered greater than null.

Дополнительно

Применяется к