Méthode ITextRange ::InRange (tom.h)

Article
03/06/2024

Détermine si cette plage se trouve dans ou dans le même texte qu’une plage spécifiée.

Syntaxe

HRESULT InRange(
  ITextRange *pRange,
  long       *pValue
);

Paramètres

pRange

Type : ITextRange*

Texte comparé à la plage actuelle.

pValue

Type : long*

Résultat de la comparaison. Le pointeur peut être null. La méthode retourne pB est tomTrue uniquement si la plage se trouve dans ou au même texte que pRange.

Valeur retournée

Type : HRESULT

La méthode retourne une valeur HRESULT . Si la méthode réussit, elle retourne S_OK. Si la méthode échoue, elle retourne S_FALSE.

Remarques

Pour que range2 soit contenu dans range1, les deux plages doivent se trouver dans le même article, et les limites de range2 doivent satisfaire à l’une des instructions suivantes.

Les positions des caractères de début et de fin de range1 sont identiques à range2. Autrement dit, les deux plages sont dégénérées et ont des points d’insertion identiques.
Range2 est une plage non dégénérée avec des positions de caractère de début et de fin au niveau de ou dans celles de range1.

L’exemple suivant montre comment parcourir une plage avec une autre.

    range2 = range1.Duplicate
    range2.End = range2.Start       ' Collapse range2 to its start position 
    While range2.InRange(range1)    ' Iterate so long as range2 remains within range1
         ...   ' This code would change the range2 character positions 
    Wend

Lorsque les familles de méthodes ITextRange ::FindText, ITextRange ::MoveWhile et ITextRange ::MoveUntil sont utilisées, vous pouvez utiliser une plage pour en parcourir une autre en spécifiant le nombre de caractères limité approprié (pour obtenir un exemple, voir les remarques dans ITextRange ::Find).

ITextRange ::IsEqual est un cas spécial de ITextRange ::InRange qui retourne pBtomTrue si le pRange a les mêmes positions de caractère de début et de fin et appartient à la même histoire.

Configuration requise

Condition requise	Valeur
Client minimal pris en charge	Windows Vista [applications de bureau uniquement]
Serveur minimal pris en charge	Windows Server 2003 [applications de bureau uniquement]
Plateforme cible	Windows
En-tête	tom.h
DLL	Msftedit.dll