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

  • Artikel

Entfernt den Kontext vom anfang des Kontextstapels.

Syntax

HRESULT Pop(
  [in] DWORD dwFlags
);

Parameter

[in] dwFlags

Wenn dieser Wert 0 ist, wird nur der Kontext oben im Stapel entfernt. Wenn dieser Wert TF_POPF_ALL ist, werden alle Kontexte aus dem Stapel entfernt.

Rückgabewert

Diese Methode kann einen dieser Werte zurückgeben.

Wert BESCHREIBUNG
S_OK
 Die Methode war erfolgreich.
E_FAIL
 Der Stapel ist leer, oder diese Methode wird ohne das flag TF_POPF_ALL aufgerufen, und nur ein einzelner Kontext befindet sich im Stapel.
E_UNEXPECTED
 Diese Methode wurde während eines weiteren ITfDocumentMgr::P op-Aufrufs aufgerufen.
E_INVALIDARG
 dwFlags ist ungültig.

Hinweise

Diese Methode muss aus demselben Thread wie der entsprechende ITfDocumentMgr::P ush-Aufruf aufgerufen werden.

Der erste Kontext, der dem Stapel hinzugefügt wird, wird zum primären Kontext. Der primäre Kontext kann nicht aus dem Stapel entfernt werden, ohne das flag TF_POPF_ALL zu verwenden. Wenn das Dokument nicht initialisiert wird, sollte diese Methode mit dem flag TF_POPF_ALL aufgerufen werden. Dies bewirkt, dass der Dokument-Manager alle Kontexte aus dem Kontextstapel entfernt und jede Textdienst-Benutzeroberfläche beendet. Verwenden Sie das flag TF_POPF_ALL zu keinem anderen Zeitpunkt.

Diese Methode bewirkt, dass die ITfThreadMgrEventSink::OnPopContext-Methode aller installierten Thread-Manager-Ereignissenken aufgerufen wird. Wenn der letzte Kontext aus dem Stapel entfernt wird, bewirkt diese Methode, dass die ITfThreadMgrEventSink::OnUninitDocumentMgr-Methode aller installierten Thread-Manager-Ereignissenken aufgerufen wird.

Anforderungen

   
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

ITfDocumentMgr

ITfDocumentMgr::P ush

ITfThreadMgrEventSink::OnPopContext

ITfThreadMgrEventSink::OnUninitDocumentMgr