Méthode IAnchor ::Shift (textstor.h)

Article
03/02/2024

La méthode IAnchor ::Shift déplace l’ancre vers l’avant ou vers l’arrière dans un flux de texte.

Syntaxe

HRESULT Shift(
  [in]  DWORD   dwFlags,
  [in]  LONG    cchReq,
  [out] LONG    *pcch,
  [in]  IAnchor *paHaltAnchor
);

Paramètres

[in] dwFlags

Champs de bits utilisés pour éviter le positionnement de l’ancre.

Valeur	Signification
TS_SHIFT_COUNT_ONLY	L’ancre n’est pas décalée. Si l’indicateur n’est pas défini (dwFlags = 0), l’ancre est décalée comme spécifié par les autres paramètres.

[in] cchReq

Nombre de caractères pour déplacer l’ancre dans le flux de texte.

[out] pcch

Nombre réel de caractères déplacés dans le flux de texte. La méthode définit pcch sur zéro en cas d’échec.

[in] paHaltAnchor

Référence à une ancre qui bloque le décalage. Définissez sur NULL pour éviter de bloquer le décalage.

Valeur retournée

Cette méthode peut retourner l’une de ces valeurs.

Valeur	Description
S_OK	La méthode a réussi.
E_FAIL	Le décalage a échoué.
E_INVALIDARG	Une valeur de paramètre d’entrée n’est pas valide.
E_NOTIMPL	La valeur du paramètre dwFlags n’est pas implémentée dans cette méthode.

Remarques

Les paramètres cchReq et pcch peuvent être négatifs, c’est-à-dire un décalage vers l’arrière dans le flux de texte, ou positifs, c’est-à-dire un décalage vers l’avant. Le nombre réel de caractères décalés peut être inférieur à cchReq si le début ou la fin du document est rencontré, si une limite de région est rencontrée ou si paHaltAnchor reçoit une ancre qui bloque le décalage.

Si paHaltAnchor reçoit une ancre qui bloque le décalage, l’application tronque le décalage à la position occupée par paHaltAnchor. Si paHaltAnchor ne se trouve pas dans l’étendue de texte couverte par le décalage, il n’a aucune pertinence pour le décalage et est ignoré.

Par exemple, si l’ancre référencée par paHaltAnchor se trouve 8 caractères avant l’ancre dans le flux et qu’un client appelle Shift (0, 10, pcch, paHaltAnchor), à la sortie, l’ancre n’aura déplacé que 8 caractères. Si l’ancre référencée par paHaltAnchor est égale à l’ancre actuelle à déplacer, La touche Maj retourne correctement sans déplacer l’ancre du tout. Dans ce cas , pcch sera 0.

Le décalage d’ancre est toujours bloqué par les limites de région, comme si le début ou la fin du document était rencontré. Cela sera indiqué à la sortie par le pcch de shift réel étant plus petit en valeur absolue que le cchReq de décalage demandé. Dans ce cas, les clients peuvent utiliser IAnchor ::ShiftRegion pour déplacer l’ancre dans une région adjacente.

Configuration requise

Condition requise	Valeur
Client minimal pris en charge	Windows 2000 Professionnel [applications de bureau uniquement]
Serveur minimal pris en charge	Windows 2000 Server [applications de bureau uniquement]
Plateforme cible	Windows
En-tête	textstor.h
DLL	Msctf.dll
Composant redistribuable	TSF 1.0 sur Windows 2000 Professionnel

Voir aussi

IAnchor

IAnchor ::ShiftRegion

Partager via