String.IComparable.CompareTo(Object) Méthode

Définition

Espace de noms:

System

Assembly:

System.Runtime.dll

Compare cette instance avec un Object spécifié et indique si cette instance précède, suit ou apparaît à la même position dans l'ordre de tri que le Object spécifié.

C#

int IComparable.CompareTo(object value);

Paramètres

value

Object

Objet qui prend pour valeur String.

Retours

Int32

Entier signé 32 bits qui indique si cette instance précède, suit ou apparaît dans la même position dans l'ordre de tri que le paramètre value.

Value	Condition
Inférieure à zéro	Cette instance précède value.
Zéro	Cette instance a la même position dans l'ordre de tri que value.
Supérieure à zéro	Cette instance suit value, ou value est null.

Implémente

CompareTo(Object)

Exceptions

ArgumentException

value n’est pas un String.

Exemples

L’exemple suivant utilise la CompareTo méthode avec un Object. Comme elle tente de comparer une String instance à un TestClass objet, la méthode lève un ArgumentException.

C#

using System;

public class TestClass
{}

public class Example
{
   public static void Main()
   {
      var test = new TestClass();
      Object[] objectsToCompare = { test, test.ToString(), 123,
                                    123.ToString(), "some text",
                                    "Some Text" };
      string s = "some text";
      foreach (var objectToCompare in objectsToCompare) {
         try {
            int i = s.CompareTo(objectToCompare);
            Console.WriteLine("Comparing '{0}' with '{1}': {2}",
                              s, objectToCompare, i);
         }
         catch (ArgumentException) {
            Console.WriteLine("Bad argument: {0} (type {1})",
                              objectToCompare,
                              objectToCompare.GetType().Name);
         }
      }
   }
}
// The example displays the following output:
//    Bad argument: TestClass (type TestClass)
//    Comparing 'some text' with 'TestClass': -1
//    Bad argument: 123 (type Int32)
//    Comparing 'some text' with '123': 1
//    Comparing 'some text' with 'some text': 0
//    Comparing 'some text' with 'Some Text': -1

Remarques

value doit être un String objet.

Attention

La CompareTo méthode a été conçue principalement pour être utilisée dans les opérations de tri ou d’alphabetisation. Il ne doit pas être utilisé lorsque l’objectif principal de l’appel de méthode est de déterminer si deux chaînes sont équivalentes. Pour déterminer si deux chaînes sont équivalentes, appelez la Equals méthode .

Cette méthode effectue une comparaison de mots (respectant la casse et la culture) à l’aide de la culture actuelle. Pour plus d’informations sur les tris de mots, de chaîne et d’ordinaux, consultez System.Globalization.CompareOptions.

Pour plus d’informations sur le comportement de cette méthode, consultez la section Remarques de la String.Compare(String, String) méthode.

S’applique à