StrComp, fonction (Visual Basic)

Article
08/21/2008

Mise à jour : novembre 2007

Retourne -1, 0 ou 1, à partir du résultat d'une comparaison de chaînes.

Public Shared Function StrComp( _
   ByVal String1 As String, _
   ByVal String2 As String, _
   <Microsoft.VisualBasic.OptionCompareAttribute> _
   Optional ByVal Compare As Microsoft.VisualBasic.CompareMethod _
) As Integer

Paramètres

String1
Requis. Toute expression String valide.
String2
Requis. Toute expression String valide.
Compare
Facultatif. Spécifie le type de comparaison de chaînes. Si l'argument Compare est omis, le paramètre Option Compare détermine le type de comparaison.

Paramètres

L'argument Compare peut prendre les valeurs suivantes :

Constante	Description
Binary	Effectue une comparaison binaire à partir d'un ordre de tri dérivé des représentations binaires internes des caractères.
Text	Effectue une comparaison textuelle à partir d'un ordre de tri textuel ne tenant pas compte de la casse et déterminé par les informations actuelles de culture de votre application.

Valeur de retour

La fonction StrComp retourne les valeurs suivantes :

Si	La fonction StrComp retourne
String1 se situe avant String2	-1
String1 est égal à String2	0
String1 se situe après String2	1

Exceptions

Type d'exception	Numéro de l'erreur	Condition
ArgumentException	5	La valeur Compare n'est pas valide.

Consultez la colonne « Numéro d'erreur » si vous mettez à niveau des applications Visual Basic 6.0 qui utilisent la gestion des erreurs non structurée. (Vous pouvez comparer le numéro d'erreur par rapport à Number, propriété (objet Err).) Toutefois, lorsque cela est possible, vous devez envisager de remplacer un tel contrôle d'erreur par Vue d'ensemble de la gestion structurée des exceptions pour Visual Basic.

Notes

Les chaînes sont comparées par valeurs de tri alphanumérique en commençant par le premier caractère. Pour plus d'informations sur les comparaisons binaires, les comparaisons textuelles et l'ordre de tri, consultez Option Compare, instruction.

Note de sécurité :
Si votre application prend des décisions relatives à la sécurité en fonction du résultat d'une comparaison ou d'une opération de modification des majuscules et des minuscules, l'opération doit utiliser la méthode String.Compare et passer Ordinal ou OrdinalIgnoreCase pour l'argument comparisonType. Pour plus d'informations, consultez Comment les informations de culture affectent les chaînes dans Visual Basic.

Si votre application prend des décisions relatives à la sécurité en fonction du résultat d'une comparaison ou d'une opération de modification des majuscules et des minuscules, l'opération doit utiliser la méthode String.Compare et passer Ordinal ou OrdinalIgnoreCase pour l'argument comparisonType. Pour plus d'informations, consultez Comment les informations de culture affectent les chaînes dans Visual Basic.

Exemple

L'exemple suivant utilise la fonction StrComp pour retourner les résultats d'une comparaison de chaînes. Si le troisième argument est omis, le type de comparaison défini dans l'instruction Option Compare ou les paramètres par défaut du projet s'exécute alors.

' Defines variables.
Dim TestStr1 As String = "ABCD"
Dim TestStr2 As String = "abcd"
Dim TestComp As Integer
' The two strings sort equally. Returns 0.
TestComp = StrComp(TestStr1, TestStr2, CompareMethod.Text)
' TestStr1 sorts after TestStr2. Returns -1.
TestComp = StrComp(TestStr1, TestStr2, CompareMethod.Binary)
' TestStr2 sorts before TestStr1. Returns 1.
TestComp = StrComp(TestStr2, TestStr1)