ITfDocumentMgr ::P ush, méthode (msctf.h)

Article
03/06/2024

Ajoute un contexte en haut de la pile de contextes.

Syntaxe

HRESULT Push(
  [in] ITfContext *pic
);

Paramètres

[in] pic

Pointeur vers l’objet ITfContext à ajouter à la pile. Cet objet est obtenu à partir d’un appel précédent à ITfDocumentMgr ::CreateContext.

Valeur retournée

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

Valeur	Description
S_OK	La méthode a réussi.
E_INVALIDARG	l’image n’est pas valide.
TF_E_STACKFULL	Il n’existe aucun espace sur la pile pour le contexte. La pile de contextes a une limite de deux contextes.
E_UNEXPECTED	Cette méthode a été appelée lors d’un appel ITfDocumentMgr ::P op .

Remarques

Le premier contexte ajouté à la pile devient le main contexte de document.

Le gestionnaire TSF et les services de texte interagissent uniquement avec le contexte situé en haut de la pile. Normalement, seul le contexte de document main se trouve sur la pile. Parfois, il est nécessaire d’ajouter un deuxième contexte à la pile. Par exemple, lorsqu’un service de texte doit afficher une interface utilisateur modale, telle qu’une liste de candidats. Pendant ce temps, le service de texte ajoute son contexte à la pile. Lorsque l’interface utilisateur du service de texte n’est plus nécessaire, le service de texte supprime le contexte de la pile. Le contexte main retourne ensuite en haut de la pile. Pour simplifier ce processus et empêcher l’affichage de plusieurs interfaces utilisateur modales, deux contextes maximum sont autorisés sur la pile.

Cette méthode entraîne l’appel de la méthode ITfThreadMgrEventSink ::OnPushContext de tous les récepteurs d’événements du gestionnaire de threads installés. S’il s’agit du premier contexte à ajouter à la pile, cette méthode provoque l’appel de la méthode ITfThreadMgrEventSink ::OnInitDocumentMgr de tous les récepteurs d’événements du gestionnaire de threads installés.

ITfDocumentMgr ::P op doit être appelé pour supprimer ce contexte de la pile de contexte.

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