ITfContextOwnerCompositionServices::TerminateComposition-Methode (msctf.h)

Artikel
08/24/2023

Beendet eine Komposition.

Syntax

HRESULT TerminateComposition(
  [in] ITfCompositionView *pComposition
);

Parameter

[in] pComposition

Zeiger auf eine ITfCompositionView-Schnittstelle , die die zu beendende Komposition darstellt. Wenn dieser Wert NULL ist, werden alle Kompositionen im Kontext beendet.

Rückgabewert

Diese Methode kann einen dieser Werte zurückgeben.

Wert	BESCHREIBUNG
S_OK	Die Methode war erfolgreich.
TF_E_DISCONNECTED	Der Kontext befindet sich nicht in einem Dokumentstapel.
TF_E_NOLOCK	Ein Textdienst hält derzeit eine Sperre für das Dokument bereit.
E_UNEXPECTED	Diese Methode wurde während eines anderen Kompositionsvorgangs aufgerufen.
E_FAIL	Es ist ein unbekannter Fehler aufgetreten.

Hinweise

Ein Textdienst verwendet ITfComposition::EndComposition , um eine komposition zu beenden, die er erstellt hat.

Wenn der Kontextbesitzer den Textspeicher implementiert, muss der Kontextbesitzer vor dem Aufrufen dieser Methode eine synchrone Schreibsperre gewähren können.

Diese Methode führt auch folgendes aus:

Für jede beendete Komposition wird ITfCompositionSink::OnCompositionTerminated für alle installierten Kompositionssenken aufgerufen.
Wenn der Kontextbesitzer eine Empfehlungssenke für die Kontextbesitzerkomposition installiert hat, wird ITfContextOwnerCompositionSink::OnEndComposition für jede beendete Komposition aufgerufen.
Die eigenschaft GUID_PROP_COMPOSING wird für den Text gelöscht, der von jeder beendeten Komposition abgedeckt wird.

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

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

Freigeben über