Método ITextStoreACP::GetText (textstor.h)
O método ITextStoreACP::GetText retorna informações sobre texto em uma posição de caractere especificada. Esse método retorna o texto visível e oculto e indica se os dados inseridos estão anexados ao texto.
Sintaxe
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
);
Parâmetros
[in] acpStart
Especifica a posição do caractere inicial.
[in] acpEnd
Especifica a posição do caractere final. Se esse parâmetro for -1, retorne todo o texto no repositório de texto.
[out] pchPlain
Especifica o buffer para receber os dados de texto sem formatação. Se esse parâmetro for NULL, o parâmetro cchPlainReq deverá ser 0.
[in] cchPlainReq
Especifica o número de caracteres de texto sem formatação passados para o método .
[out] pcchPlainRet
Recebe o número de caracteres copiados para o buffer de texto sem formatação. Esse parâmetro não pode ser NULL. Use um parâmetro se os valores não forem necessários.
[out] prgRunInfo
Recebe uma matriz de estruturas de TS_RUNINFO . Pode ser NULL somente se cRunInfoReq = 0.
[in] cRunInfoReq
Especifica o tamanho, em caracteres, do buffer de execução de texto.
[out] pcRunInfoRet
Recebe o número de estruturas de TS_RUNINFO gravadas no buffer de execução de texto. Esse parâmetro não pode ser NULL.
[out] pacpNext
Recebe a posição do caractere do próximo caractere não lido. Não pode ser NULL.
Retornar valor
Esse método pode retornar um desses valores.
| Valor | Descrição |
|---|---|
|
O método foi bem-sucedido. |
|
Os parâmetros acpStart ou acpEnd estão fora do texto do documento. |
|
O chamador não tem um bloqueio somente leitura no documento. |
Comentários
Os chamadores que usam esse método devem ter um bloqueio somente leitura no documento chamando o método ITextStoreACP::RequestLock . Sem um bloqueio somente leitura, o método falha e retorna TF_E_NOLOCK.
Os aplicativos também podem truncar os valores retornados pelo método por motivos internos. Os chamadores devem examinar cuidadosamente os caracteres de retorno e as contagens de execução de texto para obter os valores retornados necessários. Se os valores retornados estiverem incompletos, chame repetidamente o método até que os valores retornados sejam concluídos.
O chamador só pode solicitar texto sem formatação definindo o parâmetro cRunInfoReq como 0 e o parâmetro prgRunInfo como NULL. O chamador pode solicitar somente dados de execução de texto definindo o parâmetro cchPlainReq como 0 e o parâmetro pchPlain como NULL. No entanto, o chamador ainda deve fornecer valores não nulos válidos para pcchPlainRet, mesmo que esse parâmetro não seja usado.
Se acpEnd for -1, ele deverá ser tratado como se estivesse definido no final do fluxo. Caso contrário, ele será maior ou igual a zero.
Na saída, pacpNext deve ser definido como a posição de caractere do próximo caractere no fluxo não referenciado pelos valores retornados. Um chamador usaria isso para verificar rapidamente o texto com várias chamadas ITextStoreACP::GetText.
Requisitos
| Requisito | Valor |
|---|---|
| Cliente mínimo com suporte | Windows 2000 Professional [somente aplicativos da área de trabalho] |
| Servidor mínimo com suporte | Windows 2000 Server [somente aplicativos da área de trabalho] |
| Plataforma de Destino | Windows |
| Cabeçalho | textstor.h |
| DLL | Msctf.dll |
| Redistribuível | TSF 1.0 no Windows 2000 Professional |