ITfRange::SetText, méthode (msctf.h)

Article
08/24/2023

La méthode ITfRange::SetText remplace le contenu couvert par la plage de texte. Pour un objet de plage vide, la méthode entraîne une insertion à l’emplacement de la plage. Si le nouveau contenu est une chaîne vide (cch = 0), la méthode supprime le contenu existant dans la plage.

Syntaxe

HRESULT SetText(
  [in] TfEditCookie ec,
  [in] DWORD        dwFlags,
  [in] const WCHAR  *pchText,
  [in] LONG         cch
);

Paramètres

[in] ec

Identifie le contexte de modification obtenu à partir de ITfDocumentMgr::CreateContext ou ITfEditSession::D oEditSession.

[in] dwFlags

Spécifie le comportement facultatif pour la correction du contenu. Si elle est définie sur la valeur de TF_ST_CORRECTION, l’opération est une correction du contenu existant, et non une création de contenu, et les propriétés de texte d’origine sont conservées.

[in] pchText

Pointeur vers une mémoire tampon qui contient le texte pour remplacer le contenu de la plage.

[in] cch

Contient le nombre de caractères dans pchText.

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_COMPOSITION_REJECTED	Le propriétaire du contexte a rejeté une composition par défaut.
TF_E_NOLOCK	La valeur du paramètre ec est un cookie non valide, ou l’appelant n’a pas de verrou en lecture/écriture.
TF_E_RANGE_NOT_COVERED	La plage ne se trouve pas dans la composition active de l’appelant.

Notes

Lorsqu’une plage couvre plusieurs régions, appelez ITfRange::SetText sur chaque région séparément. Sinon, la méthode peut échouer.

Par défaut, les services de texte démarrent et terminent une composition temporaire qui couvre la plage, pour s’assurer que les propriétaires de contexte reconnaissent systématiquement les compositions sur le texte modifié. Si le propriétaire de la composition rejette une composition par défaut, la méthode retourne TF_E_COMPOSITION_REJECTED. Les compositions par défaut sont créées uniquement si l’appelant n’en a pas déjà démarré une. Si l’appelant a une composition active, l’appel échoue.

Le caractère d’espace réservé d’objet TF_CHAR_EMBEDDED peut ne pas être passé dans cette méthode. ITfRange::InsertEmbedded doit être utilisé à la place.

Pour l’insertion de texte, la méthode ITFInsertAtSelection:InsertTextAtSelection ne nécessite pas d’allocation de plage de sélection et évite que la plage corresponde à la sélection.

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