Méthode ITfRange::CompareStart (msctf.h)

Article
08/24/2023

La méthode ITfRange::CompareStart compare la position d’ancrage de début de cette plage de texte à une ancre dans une autre plage.

Syntaxe

HRESULT CompareStart(
  [in]  TfEditCookie ec,
  [in]  ITfRange     *pWith,
  [in]  TfAnchor     aPos,
  [out] LONG         *plResult
);

Paramètres

[in] ec

Modifier le cookie obtenu à partir de ITfDocumentMgr::CreateContext ou ITfEditSession::D oEditSession.

[in] pWith

Pointeur vers une plage spécifiée dans laquelle une ancre doit être comparée à cette ancre de début de plage.

[in] aPos

Élément d’énumération qui indique l’ancre de la plage pWith spécifiée à comparer à cette ancre de début de plage.

Valeur	Signification
TF_ANCHOR_START	Comparez cette ancre de début de plage avec l’ancre de début de plage spécifiée.
TF_ANCHOR_END	Comparez cette ancre de début de plage avec l’ancre de fin de plage spécifiée.

[out] plResult

Pointeur vers le résultat de la comparaison entre cette ancre de début de plage et l’ancre de plage pWith spécifiée.

Valeur	Signification
-1	Cette ancre de début se trouve derrière l’ancre de la plage spécifiée (position de cette position d’ancre < de début de l’ancre de la plage spécifiée).
0	Cette ancre de début se trouve à la même position que l’ancre de la plage spécifiée.
+1	Cette ancre de début est en avance sur l’ancre de la plage spécifiée (position de cette position d’ancre > de début de l’ancre de la plage spécifiée).

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	Une erreur non spécifiée s'est produite.
E_INVALIDARG	Un ou plusieurs paramètres ne sont pas valides.
TF_E_NOLOCK	La valeur du paramètre ec est un cookie non valide, ou l’appelant n’a pas de verrou en lecture seule.

Notes

Cette méthode ne retourne jamais 0, sauf si les deux ancres se trouvent dans une seule région. Si l’appelant nécessite uniquement des informations sur la position des deux ancres au même emplacement, ITfRange::IsEqualStart est plus efficace.

Spécifications


Client minimal pris en charge	Windows 2000 Professionnel [applications de bureau \| Applications UWP]
Serveur minimal pris en charge	Windows 2000 Server [applications de bureau \| Applications UWP]
Plateforme cible	Windows
En-tête	msctf.h
DLL	Msctf.dll
Composant redistribuable	TSF 1.0 sur Windows 2000 Professionnel