Metodo ITextStoreAnchor::GetText (textstor.h)
Il metodo ITextStoreAnchor::GetText restituisce informazioni sul testo in una posizione di ancoraggio specificata. Questo metodo restituisce il testo visibile e nascosto e indica se i dati incorporati sono collegati al testo.
Sintassi
HRESULT GetText(
[in] DWORD dwFlags,
[in] IAnchor *paStart,
[in] IAnchor *paEnd,
[out] WCHAR *pchText,
[in] ULONG cchReq,
[out] ULONG *pcch,
[in] BOOL fUpdateAnchor
);
Parametri
[in] dwFlags
Non usato; dovrebbe essere zero.
[in] paStart
Specifica la posizione di ancoraggio iniziale.
[in] paEnd
Specifica la posizione di ancoraggio finale. Se NULL, viene considerato come se fosse un ancoraggio posizionato alla fine del flusso di testo.
[out] pchText
Specifica il buffer da ricevere il testo. Può essere NULL solo quando cchReq = 0.
[in] cchReq
Specifica le dimensioni del buffer pchText in caratteri.
[out] pcch
Riceve il numero di caratteri copiati nel buffer pchText .
[in] fUpdateAnchor
Se TRUE, paStart verrà riposizionato solo dopo l'ultimo carattere copiato in pchText.
Valore restituito
Questo metodo può restituire uno di questi valori.
valore | Descrizione |
---|---|
|
Metodo completato correttamente. |
|
Il metodo non è riuscito a ottenere un puntatore dell'interfaccia valido a paStart e/o paEnd. |
|
Gli ancoraggi paStart o paEnd sono esterni al testo del documento. |
|
Il chiamante non dispone di un blocco di sola lettura nel documento. |
Commenti
I chiamanti che usano questo metodo devono avere un blocco di sola lettura nel documento chiamando il metodo ITextStoreAnchor::RequestLock . Senza un blocco di sola lettura, il metodo ha esito negativo e restituisce TF_E_NOLOCK.
Le applicazioni possono troncare i valori restituiti dal metodo per motivi interni.
Per analizzare rapidamente il testo con più chiamate GetText , un chiamante userà fUpdateAnchor = TRUE.
Il numero effettivo di caratteri copiati potrebbe essere minore di cchReq se il numero di caratteri tra paStart e paEnd è minore di cchReq.
Il comportamento di GetText non è interessato da alcun limite di area coperto dal testo restituito.
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 | textstor.h |
DLL | Msctf.dll |
Componente ridistribuibile | TSF 1.0 in Windows 2000 Professional |