Metodo ITextStoreACP2::GetText (textstor.h)
Ottiene informazioni sul testo in una posizione di carattere specificata. Questo metodo restituisce il testo visibile e nascosto e indica se i dati incorporati sono collegati al testo.
Sintassi
HRESULT GetText(
[in] LONG acpStart,
[in] LONG acpEnd,
[out] WCHAR *pchPlain,
[in] ULONG cchPlainReq,
[out] ULONG *pcchPlainRet,
[out] TS_RUNINFO *prgRunInfo,
[in] ULONG cRunInfoReq,
[out] ULONG *pcRunInfoRet,
[out] LONG *pacpNext
);
Parametri
[in] acpStart
Specifica la posizione del carattere iniziale.
[in] acpEnd
Specifica la posizione del carattere finale. Se questo parametro è -1, restituire tutto il testo nell'archivio di testo.
[out] pchPlain
Specifica il buffer per ricevere i dati di testo normale. Se questo parametro è NULL, il parametro cchPlainReq deve essere 0.
[in] cchPlainReq
Specifica il numero di caratteri di testo normale passati al metodo.
[out] pcchPlainRet
Riceve il numero di caratteri copiati nel buffer di testo normale. Questo parametro non può essere NULL. Usare un parametro se i valori non sono necessari.
[out] prgRunInfo
Riceve una matrice di strutture TS_RUNINFO . Può essere NULL solo se cRunInfoReq = 0.
[in] cRunInfoReq
Specifica le dimensioni, in caratteri, del buffer di esecuzione del testo.
[out] pcRunInfoRet
Riceve il numero di strutture TS_RUNINFO scritte nel buffer di esecuzione del testo. Questo parametro non può essere NULL.
[out] pacpNext
Riceve la posizione del carattere del carattere successivo non letto. Impossibile essere NULL.
Valore restituito
Questo metodo può restituire uno di questi valori.
| valore | Descrizione |
|---|---|
|
Il metodo è stato eseguito correttamente. |
|
I parametri acpStart o acpEnd 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 RequestLock . Senza un blocco di sola lettura, il metodo ha esito negativo e restituisce TF_E_NOLOCK.
Le applicazioni possono anche troncare i valori restituiti dal metodo per motivi interni. I chiamanti devono esaminare attentamente i caratteri restituiti e i conteggi delle esecuzioni di testo per ottenere i valori restituiti necessari. Se i valori restituiti sono incompleti, chiamare ripetutamente il metodo fino al completamento dei valori restituiti.
Il chiamante può richiedere testo normale solo impostando il parametro cRunInfoReq su 0 e il parametro prgRunInfo su NULL. Il chiamante può richiedere solo i dati di esecuzione del testo impostando il parametro cchPlainReq su 0 e il parametro pchPlain su NULL. Tuttavia, il chiamante deve comunque fornire valori non null validi per pcchPlainRet, anche se questo parametro non viene usato.
Se acpEnd è -1, deve essere gestito come se impostato alla fine del flusso. In caso contrario, sarà maggiore o uguale a zero.
In uscita , pacpNext deve essere impostato sulla posizione del carattere successivo nel flusso non a cui fa riferimento i valori restituiti. Un chiamante userà questa operazione per analizzare rapidamente il testo con più chiamate GetText .
Requisiti
| Client minimo supportato | Windows 8 [app desktop | App UWP] |
| Server minimo supportato | Windows Server 2012 [app desktop | App UWP] |
| Piattaforma di destinazione | Windows |
| Intestazione | textstor.h |
| DLL | Msctf.dll |