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

Article
03/03/2024

Déplace les extrémités de la plage vers le début de la première unité qui se chevauche dans la plage.

Syntaxe

HRESULT StartOf(
  long Unit,
  long Extend,
  long *pDelta
);

Paramètres

Unit

Type : long

Unité à utiliser dans l’opération de déplacement. Pour obtenir la liste des valeurs d’unité , consultez la discussion sous ITextRange.

Extend

Type : long

Comment déplacer les extrémités de la plage. Il peut avoir l’une des valeurs suivantes.

0 (ou tomMove)	Réduit une plage non dégénérée à la position de départ en déplaçant le point d’insertion. Il s’agit de la valeur par défaut.
1 (ou tomExtend)	Déplace la position de début au début de l’unité qui se chevauche. Ne déplace pas la position de fin.

pDelta

Type : long*

Pointeur vers une variable qui reçoit le nombre de caractères que la position de début est déplacée. Elle ne peut pas avoir la valeur Null. Au retour, pDelta est le nombre signé de caractères que le point d’insertion ou la position de début est déplacé. Cette valeur est toujours inférieure ou égale à zéro, car le mouvement est toujours vers le début de l’histoire.

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

Remarques

Si la plage est un point d’insertion sur une limite entre unités, ITextRange ::StartOf ne modifie pas la position de début.

Les méthodes ITextRange ::StartOf et ITextRange ::EndOf diffèrent des méthodes HomeKey et EndKey en ce que ces dernières s’étendent à partir de l’extrémité active, tandis que ITextRange ::StartOf s’étend à partir de la position de début et ITextRange ::EndOf s’étend à partir de la position de fin.

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