ITfRange::SetText-Methode (msctf.h)

Artikel
08/24/2023

Die ITfRange::SetText-Methode ersetzt den Inhalt, der durch den Textbereich abgedeckt wird. Bei einem leeren Bereichsobjekt führt die -Methode zu einer Einfügung an der Position des Bereichs. Wenn der neue Inhalt eine leere Zeichenfolge ist (cch = 0), löscht die -Methode den vorhandenen Inhalt innerhalb des Bereichs.

Syntax

HRESULT SetText(
  [in] TfEditCookie ec,
  [in] DWORD        dwFlags,
  [in] const WCHAR  *pchText,
  [in] LONG         cch
);

Parameter

[in] ec

Gibt den Bearbeitungskontext an, der von ITfDocumentMgr::CreateContext oder ITfEditSession::D oEditSession abgerufen wurde.

[in] dwFlags

Gibt optionales Verhalten für die Korrektur von Inhalten an. Wenn auf den Wert von TF_ST_CORRECTION festgelegt ist, ist der Vorgang eine Korrektur des vorhandenen Inhalts, keine Erstellung neuer Inhalte, und die ursprünglichen Texteigenschaften werden beibehalten.

[in] pchText

Zeiger auf einen Puffer, der den Text zum Ersetzen des Bereichsinhalts enthält.

[in] cch

Enthält die Anzahl der Zeichen in pchText.

Rückgabewert

Diese Methode kann einen dieser Werte zurückgeben.

Wert	BESCHREIBUNG
S_OK	Die Methode war erfolgreich.
E_FAIL	Es ist ein unbekannter Fehler aufgetreten.
E_INVALIDARG	Mindestens ein Parameter ist ungültig.
TF_E_COMPOSITION_REJECTED	Der Kontextbesitzer hat eine Standardkomposition abgelehnt.
TF_E_NOLOCK	Der Wert des ec-Parameters ist ein ungültiges Cookie, oder der Aufrufer verfügt nicht über eine Lese-/Schreibsperre.
TF_E_RANGE_NOT_COVERED	Der Bereich befindet sich nicht innerhalb der aktiven Zusammensetzung des Aufrufers.

Hinweise

Wenn ein Bereich mehrere Regionen umfasst, rufen Sie ITfRange::SetText für jede Region separat auf. Andernfalls kann die -Methode fehlschlagen.

Standardmäßig starten und beenden Textdienste eine temporäre Komposition, die den Bereich abdeckt, um sicherzustellen, dass Kontextbesitzer Kompositionen über bearbeiteten Text konsistent erkennen. Wenn der Kompositionsbesitzer eine Standardkomposition ablehnt, gibt die Methode TF_E_COMPOSITION_REJECTED zurück. Standardkompositionen werden nur erstellt, wenn der Aufrufer noch keine gestartet hat. Wenn der Aufrufer über eine aktive Komposition verfügt, schlägt der Aufruf fehl.

Das TF_CHAR_EMBEDDED Objektplatzhalterzeichen wird möglicherweise nicht an diese Methode übergeben. Stattdessen sollte ITfRange::InsertEmbedded verwendet werden.

Zum Einfügen von Text erfordert die ITFInsertAtSelection:InsertTextAtSelection-Methode keinen Auswahlbereich, der zugeordnet werden muss, und vermeidet die Anforderung, dass der Bereich mit der Auswahl übereinstimmt.

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