Partager via

Méthode ITfContextOwnerCompositionServices ::TerminateComposition (msctf.h)

  • Article

Met fin à une composition.

Syntaxe

HRESULT TerminateComposition(
  [in] ITfCompositionView *pComposition
);

Paramètres

[in] pComposition

Pointeur vers une interface ITfCompositionView qui représente la composition à terminer. Si cette valeur est NULL, toutes les compositions du contexte sont terminées.

Valeur retournée

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

Valeur Description
S_OK
 La méthode a réussi.
TF_E_DISCONNECTED
 Le contexte ne se trouve pas sur une pile de documents.
TF_E_NOLOCK
 Un service de texte contient actuellement un verrou sur le document.
E_UNEXPECTED
 Cette méthode a été appelée lors d’une autre opération de composition.
E_FAIL
 Une erreur non spécifiée s'est produite.

Remarques

Un service de texte utilise ITfComposition ::EndComposition pour mettre fin à une composition qu’il a créée.

Si le propriétaire du contexte implémente le magasin de texte, il doit être en mesure d’accorder un verrou d’écriture synchrone avant d’appeler cette méthode.

Cette méthode effectue également les opérations suivantes :

  • Pour chaque composition terminée, ITfCompositionSink ::OnCompositionTerminated est appelé pour tous les récepteurs de conseil de composition installés.
  • Si le propriétaire du contexte a installé un récepteur de conseil de composition de propriétaire de contexte, ITfContextOwnerCompositionSink ::OnEndComposition est appelé pour chaque composition terminée.
  • La propriété GUID_PROP_COMPOSING sera effacée pour le texte couvert par chaque composition terminée.

Configuration requise

Condition requise Valeur
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

Voir aussi

ITfComposition ::EndComposition, nf-msctf-itfcompositionsink-oncompositionterminated, interface ITfCompositionView, interface ITfContextOwnerCompositionServices, ITfContextOwnerCompositionSink ::OnEndComposition