Partager via

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

  • Article

Remplace cette plage par l’unité spécifiée de l’article.

Syntaxe

HRESULT SetIndex(
  [in] long Unit,
  [in] long Index,
  [in] long Extend
);

Paramètres

[in] Unit

Type : long

Unité utilisée pour indexer la plage. Pour obtenir la liste des valeurs d’unité, consultez ITextRange.

[in] Index

Type : long

Index de l’unité. Cette plage est déplacée vers l’unité qui a ce numéro d’index. Si elle est positive, la numérotation des unitéscommence au début de l’histoire et continue. Si elle est négative, la numérotation commence à la fin de l’histoire et se poursuit vers l’arrière. Le début de l’article correspond à un index de 1 pour toutes les unités qui existent, et la dernière unité de l’article correspond à un index de -1.

[in] Extend

Type : long

Indicateur qui indique l’étendue de la plage. Si la valeur est égale à zéro (valeur par défaut), la plage est réduite à un point d’insertion à la position de début de l’unité spécifiée. Si ce n’est pas zéro, la plage est définie sur l’unité entière.

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
E_INVALIDARG
 Index non valide.
E_NOTIMPL
 L’unité n’est pas prise en charge.
S_FALSE
 Échec pour une autre raison.

Remarques

Cette méthode permet à une application de travailler avec du texte orienté ligne, tel que des programmes, de manière pratique. Par exemple, SetIndex(tomLine, 10, 0) convertit une plage en point d’insertion au début de la dixième ligne.

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

ITextRange

Référence

Modèle objet texte