Metodo ITfRange::SetText (msctf.h)

Articolo
03/08/2023

Il metodo ITfRange::SetText sostituisce il contenuto coperto dall'intervallo di testo. Per un oggetto intervallo vuoto, il metodo genera un inserimento nella posizione dell'intervallo. Se il nuovo contenuto è una stringa vuota (cch = 0), il metodo elimina il contenuto esistente all'interno dell'intervallo.

Sintassi

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

Parametri

[in] ec

Identifica il contesto di modifica ottenuto da ITfDocumentMgr::CreateContext o ITfEditSession::D oEditSession.

[in] dwFlags

Specifica il comportamento facoltativo per la correzione del contenuto. Se impostato sul valore di TF_ST_CORRECTION, l'operazione è una correzione del contenuto esistente, non una creazione di nuovo contenuto e le proprietà di testo originali vengono mantenute.

[in] pchText

Puntatore a un buffer contenente il testo per sostituire il contenuto dell'intervallo.

[in] cch

Contiene il numero di caratteri in pchText.

Valore restituito

Questo metodo può restituire uno di questi valori.

Valore	Descrizione
S_OK	Il metodo è stato eseguito correttamente.
E_FAIL	Si è verificato un errore non specificato.
E_INVALIDARG	Uno o più parametri non sono validi.
TF_E_COMPOSITION_REJECTED	Il proprietario del contesto ha rifiutato una composizione predefinita.
TF_E_NOLOCK	Il valore del parametro ec è un cookie non valido oppure il chiamante non ha un blocco di lettura/scrittura.
TF_E_RANGE_NOT_COVERED	L'intervallo non rientra nella composizione attiva del chiamante.

Commenti

Quando un intervallo copre più aree, chiamare ITfRange::SetText in ogni area separatamente. In caso contrario, il metodo può non riuscire.

Per impostazione predefinita, i servizi di testo iniziano e terminano una composizione temporanea che copre l'intervallo, per garantire che i proprietari del contesto riconoscano in modo coerente le composizioni rispetto al testo modificato. Se il proprietario della composizione rifiuta una composizione predefinita, il metodo restituisce TF_E_COMPOSITION_REJECTED. Le composizioni predefinite vengono create solo se il chiamante non ne ha già avviato uno. Se il chiamante ha una composizione attiva, la chiamata ha esito negativo.

Il carattere segnaposto dell'oggetto TF_CHAR_EMBEDDED potrebbe non essere passato a questo metodo. ITfRange::InsertEmbedded deve essere usato invece.

Per l'inserimento del testo, il metodo ITFInsertAtSelection:InsertTextAtSelection non richiede l'allocazione di un intervallo di selezione ed evita il requisito che l'intervallo corrisponda alla selezione.

Requisiti


Client minimo supportato	Windows 2000 Professional [app desktop \| App UWP]
Server minimo supportato	Windows 2000 Server [app desktop \| App UWP]
Piattaforma di destinazione	Windows
Intestazione	msctf.h
DLL	Msctf.dll
Componente ridistribuibile	TSF 1.0 in Windows 2000 Professional