InStr, fonction (Visual Basic)

Mise à jour : novembre 2007

Retourne un entier spécifiant la position de début de la première occurrence d'une chaîne à l'intérieur d'une autre.

Public Shared Function InStr(_
   ByVal String1 As String, _
   ByVal String2 As String, _
   Optional ByVal Compare As CompareMethod _
) As Integer
' -or-
Public Shared Function InStr(_
   ByVal Start As Integer, _
   ByVal String1 As String, _
   ByVal String2 As String, _
   Optional ByVal Compare As Microsoft.VisualBasic.CompareMethod _
) As Integer

Paramètres

  • Start
    Facultatif. Expression numérique qui définit la position de départ de chaque recherche. Si cet argument est omis, la recherche commence à la position du premier caractère. L'index de début est de base 1.

  • String1
    Requis. Expression String recherchée.

  • String2
    Requis. Expression String recherchée.

  • Compare
    Facultatif. Spécifie le type de comparaison de chaînes. Si 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

Valeur

Description

Binary

0

Effectue une comparaison binaire.

Text

1

Effectue une comparaison textuelle.

Valeur de retour

Si

La fonction InStr retourne

String1 est de longueur nulle ou Nothing

0

String2 est de longueur nulle ou Nothing

start

String2 est introuvable

0

String2 est trouvé dans String1

Position où commence la correspondance

Start > String2

0

Exceptions

Type d'exception

Numéro de l'erreur

Condition

ArgumentException

5

Start < 1.

Consultez la colonne « Numéro d'erreur » si vous mettez à niveau des applications Visual Basic 6.0 qui utilisent la gestion non structurée des erreurs. (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'erreurs par Vue d'ensemble de la gestion structurée des exceptions pour Visual Basic.

Notes

En général, la fonction InStr est utilisée lors de l'analyse de chaînes.

Remarque :

Dans les précédentes versions de Visual Basic, la fonction InStrB retourne un nombre d'octets plutôt qu'une position de caractère. Son rôle est d'abord de convertir des chaînes en applications à jeu de caractères codés sur deux octets (DBCS, Double-Byte Character Set). Toutes les chaînes Visual Basic 2005 sont en Unicode et la fonction InStrB n'est plus prise en charge.

Exemple

L'exemple suivant utilise la fonction InStr pour retourner la position de la première occurrence d'une chaîne à l'intérieur d'une autre.

' String to search in.
Dim SearchString As String = "XXpXXpXXPXXP"
' Search for "P".
Dim SearchChar As String = "P"

Dim TestPos As Integer
' A textual comparison starting at position 4. Returns 6.
TestPos = InStr(4, SearchString, SearchChar, CompareMethod.Text)

' A binary comparison starting at position 1. Returns 9.
TestPos = InStr(1, SearchString, SearchChar, CompareMethod.Binary)

' If Option Compare is not set, or set to Binary, return 9.
' If Option Compare is set to Text, returns 3.
TestPos = InStr(SearchString, SearchChar)

' Returns 0.
TestPos = InStr(1, SearchString, "W")

Configuration requise

Espace de noms :Microsoft.VisualBasic

**Module :**Strings

**Assembly :**bibliothèque Visual Basic Runtime (dans Microsoft.VisualBasic.dll)

Voir aussi

Concepts

Récapitulatif des modifications relatives à la prise en charge des éléments de programmation

Référence

InStrRev, fonction (Visual Basic)

Option Compare, instruction

StrComp, fonction (Visual Basic)

ArgumentException

Autres ressources

Chaînes en Visual Basic

Introduction aux chaînes en Visual Basic