Freigeben über


ITfDocumentMgr::P ush-Methode (msctf.h)

Fügt oben im Kontextstapel einen Kontext hinzu.

Syntax

HRESULT Push(
  [in] ITfContext *pic
);

Parameter

[in] pic

Zeiger auf das ITfContext-Objekt , das dem Stapel hinzugefügt werden soll. Dieses Objekt wird aus einem vorherigen Aufruf von ITfDocumentMgr::CreateContext abgerufen.

Rückgabewert

Diese Methode kann einen dieser Werte zurückgeben.

Wert BESCHREIBUNG
S_OK
Die Methode war erfolgreich.
E_INVALIDARG
pic ist ungültig.
TF_E_STACKFULL
Auf dem Stapel ist kein Leerraum für den Kontext vorhanden. Der Kontextstapel hat eine Grenze von zwei Kontexten.
E_UNEXPECTED
Diese Methode wurde während eines ITfDocumentMgr::P op-Aufrufs aufgerufen.

Hinweise

Der erste Kontext, der dem Stapel hinzugefügt wird, wird zum Standard Dokumentkontext.

Der TSF-Manager und die Textdienste interagieren nur mit dem Kontext oben im Stapel. Normalerweise befindet sich nur der Standard Dokumentkontext im Stapel. Gelegentlich ist es erforderlich, dem Stapel einen zweiten Kontext hinzuzufügen. Beispielsweise, wenn ein Textdienst eine modale Benutzeroberfläche anzeigen muss, z. B. eine Kandidatenliste. Während dieser Zeit fügt der Textdienst dem Stapel seinen Kontext hinzu. Wenn die Benutzeroberfläche des Textdiensts nicht mehr erforderlich ist, entfernt der Textdienst den Kontext aus dem Stapel. Der Standard Kontext kehrt dann an den Anfang des Stapels zurück. Um diesen Prozess zu vereinfachen und zu verhindern, dass mehrere modale UIs angezeigt werden, sind maximal zwei Kontexte für den Stapel zulässig.

Diese Methode bewirkt, dass die ITfThreadMgrEventSink::OnPushContext-Methode aller installierten Thread-Manager-Ereignissenken aufgerufen wird. Wenn dies der erste Kontext ist, der dem Stapel hinzugefügt wird, bewirkt diese Methode, dass die ITfThreadMgrEventSink::OnInitDocumentMgr-Methode aller installierten Thread-Manager-Ereignissenken aufgerufen wird.

ITfDocumentMgr::P op muss aufgerufen werden, um diesen Kontext aus dem Kontextstapel zu entfernen.

Anforderungen

Anforderung Wert
Unterstützte Mindestversion (Client) Windows 2000 Professional [Desktop-Apps | UWP-Apps]
Unterstützte Mindestversion (Server) Windows 2000 Server [Desktop-Apps | UWP-Apps]
Zielplattform Windows
Kopfzeile msctf.h
DLL Msctf.dll
Verteilbare Komponente TSF 1.0 unter Windows 2000 Professional

Weitere Informationen

ITfContext

ITfDocumentMgr

ITfDocumentMgr::CreateContext

ITfDocumentMgr::P op

ITfThreadMgrEventSink::OnInitDocumentMgr

ITfThreadMgrEventSink::OnPushContext