ITfContextComposition::StartComposition-Methode (msctf.h)

Artikel
08/24/2023

Erstellt eine neue Komposition.

Syntax

HRESULT StartComposition(
  [in]  TfEditCookie       ecWrite,
  [in]  ITfRange           *pCompositionRange,
  [in]  ITfCompositionSink *pSink,
  [out] ITfComposition     **ppComposition
);

Parameter

[in] ecWrite

Enthält ein Bearbeitungscooky, das den Bearbeitungskontext identifiziert. Dies wird von ITfEditSession::D oEditSession abgerufen.

[in] pCompositionRange

Zeiger auf ein ITfRange-Objekt , das den Text angibt, den die Komposition zunächst abdeckt.

[in] pSink

Zeiger auf ein ITfCompositionSink-Objekt , das Kompositionsereignisbenachrichtigungen empfängt. Dieser Parameter ist optional und kann NULL sein. Wenn angegeben, wird das Objekt freigegeben, wenn die Komposition beendet wird.

[out] ppComposition

Zeiger auf einen ITfComposition-Schnittstellenzeiger , der das neue Kompositionsobjekt empfängt. Dieser Parameter empfängt NULL , wenn der Kontextbesitzer die Komposition ablehnt.

Rückgabewert

Diese Methode kann einen dieser Werte zurückgeben.

Wert	BESCHREIBUNG
S_OK	Die Methode war erfolgreich. Wenn die Kompositionssenke des Kontextbesitzers die Komposition ablehnt, wird ppComposition auf NULL festgelegt.
E_FAIL	Es ist ein unbekannter Fehler aufgetreten.
E_INVALIDARG	Mindestens ein Parameter ist ungültig.
E_OUTOFMEMORY	Das Composition-Objekt kann nicht erstellt werden.
E_UNEXPECTED	Die Methode wurde innerhalb eines anderen Kompositionsvorgangs aufgerufen.
TF_E_DISCONNECTED	Das Kontextobjekt befindet sich nicht in einem Dokumentstapel.
TF_E_NOLOCK	Der durch ecWrite identifizierte Bearbeitungskontext verfügt nicht über eine Lese-/Schreibsperre.

Hinweise

Wenn der Kontextbesitzer eine Kontextbesitzerkompositionssenke installiert hat, wird die ITfContextOwnerCompositionSink::OnStartComposition-Methode aufgerufen. Wenn die Empfehlungssenke die neue Komposition ablehnt, gibt diese Methode S_OK zurück, aber ppComposition ist auf NULL festgelegt.

Jeder text, der von pCompositionRange abgedeckt wird, erhält die GUID_PROP_COMPOSING-Eigenschaft.

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

IEnumITfCompositionView-Schnittstelle, ITfContextComposition-Schnittstelle, ITfRange-Schnittstelle, ITfCompositionSink-Schnittstelle, ITfContextOwnerCompositionSink::OnStartComposition, ITfEditSession::D oEditSession

Freigeben über