Metodo ITextStoreAnchor::SetText (textstor.h)

Articolo
03/05/2024

Il metodo ITextStoreAnchor::SetText imposta la selezione del testo tra due posizioni di ancoraggio fornite.

Sintassi

HRESULT SetText(
  [in] DWORD       dwFlags,
  [in] IAnchor     *paStart,
  [in] IAnchor     *paEnd,
  [in] const WCHAR *pchText,
  [in] ULONG       cch
);

Parametri

[in] dwFlags

Se impostato sul valore di TS_ST_CORRECTION, il testo è una trasformazione (correzione) del contenuto esistente e vengono mantenute eventuali informazioni speciali di markup del testo (metadati), ad esempio .wav dati di file o un identificatore di lingua. Il client definisce il tipo di informazioni di markup da conservare.

[in] paStart

Puntatore all'ancoraggio all'inizio dell'intervallo di testo da sostituire.

[in] paEnd

Puntatore all'ancoraggio alla fine dell'intervallo di testo da sostituire. Deve sempre seguire o essere nella stessa posizione di paStart.

[in] pchText

Puntatore al testo sostitutivo. La stringa di testo non deve essere terminata null, perché il conteggio dei caratteri di testo è specificato nel parametro cch .

[in] cch

Specifica il numero di caratteri nel testo sostitutivo.

Valore restituito

Questo metodo può restituire uno di questi valori.

Valore	Descrizione
S_OK	Il metodo è stato eseguito correttamente.
E_FAIL	Il metodo non è riuscito a creare un'istanza di uno degli ancoraggi paStart o paEnd.
TS_E_INVALIDPOS	Il percorso di paStart o paEnd non è compreso nel testo del documento.
TS_E_NOLOCK	Il chiamante non dispone di un blocco di lettura/scrittura.
TS_E_READONLY	Il documento è di sola lettura. Impossibile modificare il contenuto.
TS_E_REGION	È stato effettuato un tentativo di modificare il testo attraverso un limite di area.

Commenti

Le applicazioni devono iniziare una composizione usando prima ITextStoreAnchor::InsertTextAtSelection. ITextStoreAnchor::SetText deve essere usato solo all'interno di una composizione esistente. Se non è presente alcuna composizione attiva al momento della chiamata a SetText , il gestore TSF crea una composizione che dura abbastanza a lungo per eseguire il wrapping della chiamata a SetText.

I chiamanti devono contenere un blocco di scrittura ottenuto tramite ITextStoreAnchor::RequestLock. In caso contrario, ITextStoreAnchor::SetText avrà esito negativo con TS_E_NOLOCK.

Se paStart si trova nella stessa posizione di paEnd, l'operazione è un inserimento e non verrà rimosso alcun testo esistente.

TS_CHAR_EMBEDDED non può essere passato a questo metodo. Per gli oggetti incorporati, usare invece ITextStoreAnchor::InsertEmbedded .

Questo metodo avrà esito negativo se l'intervallo di testo sostituito copre qualsiasi limite di area. I chiamanti devono invece effettuare più chiamate al metodo, una per ogni area.

Requisiti

Requisito	Valore
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	textstor.h
DLL	Msctf.dll
Componente ridistribuibile	TSF 1.0 in Windows 2000 Professional