Méthode ITextRange ::GetIndex (tom.h)
Récupère l’index d’histoire du paramètre Unit à la position de caractère de début de la plage spécifiée. La première unité d’une histoire a une valeur d’index de 1. L’index d’une unité est le même pour toutes les positions de caractères de celle qui précède immédiatement l’unité jusqu’au dernier caractère de l’unité.
Syntaxe
HRESULT GetIndex(
long Unit,
long *pIndex
);
Paramètres
Unit
Type : long
Unité indexée. Pour obtenir la liste des valeurs d’unité possibles, consultez la discussion sous ITextRange.
pIndex
Type : long*
Valeur de l’index. La valeur est égale à zéro si l’unité n’existe pas.
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 l’un des codes d’erreur suivants. Pour plus d’informations sur les codes d’erreur COM, consultez Gestion des erreurs dans COM.
| Code de retour | Description |
|---|---|
|
pIndex a la valeur Null. |
|
L’unité n’existe pas. |
Remarques
La méthode ITextRange ::GetIndex récupère l’index d’histoire d’un mot, d’une ligne, d’une phrase, d’un paragraphe, etc., à la plage Démarrer. Unit spécifie le type d’entité à indexer, comme les mots (tomWord), les lignes (tomLine), les phrases (tomSentence) ou les paragraphes (tomParagraph). Par exemple, ITextRange ::GetIndex définit pIndex comme égal au numéro de ligne de la première ligne de la plage. Pour une plage à la fin de l’histoire, ITextRange ::GetIndex retourne le nombre d’unitésdans l’histoire. Ainsi, vous pouvez obtenir le nombre de mots, de lignes, d’objets, etc. dans une histoire.
La valeur d’index retournée par la méthode ITextRange ::GetIndex n’est pas valide si le texte est modifié par la suite. Par conséquent, les utilisateurs doivent faire attention à l’utilisation de méthodes qui retournent des valeurs d’index, en particulier si les valeurs doivent être stockées pendant une durée quelconque. Cela contraste avec un pointeur vers une plage, qui reste valide lorsque le texte est modifié.
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 |
Voir aussi
Conceptuel
Référence