Método ITextStoreAnchor::GetText (textstor.h)
O método ITextStoreAnchor::GetText retorna informações sobre texto em uma posição de âncora 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] DWORD dwFlags,
[in] IAnchor *paStart,
[in] IAnchor *paEnd,
[out] WCHAR *pchText,
[in] ULONG cchReq,
[out] ULONG *pcch,
[in] BOOL fUpdateAnchor
);
Parâmetros
[in] dwFlags
Não usado; deve ser zero.
[in] paStart
Especifica a posição da âncora inicial.
[in] paEnd
Especifica a posição da âncora final. Se FOR NULL, ele será tratado como se fosse uma âncora posicionada no final do fluxo de texto.
[out] pchText
Especifica o buffer para receber o texto. Pode ser NULL somente quando cchReq = 0.
[in] cchReq
Especifica o tamanho do buffer pchText em caracteres.
[out] pcch
Recebe o número de caracteres copiados para o buffer pchText .
[in] fUpdateAnchor
Se TRUE, paStart será reposicionado logo após o último caractere copiado para pchText.
Valor retornado
Esse método pode retornar um desses valores.
| Valor | Descrição |
|---|---|
|
O método foi concluído com sucesso. |
|
O método não pôde obter um ponteiro de interface válido para paStart e/ou paEnd. |
|
As âncoras paStart ou paEnd 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 ITextStoreAnchor::RequestLock . Sem um bloqueio somente leitura, o método falha e retorna TF_E_NOLOCK.
Os aplicativos podem truncar os valores de retorno do método por motivos internos.
Para examinar rapidamente o texto com várias chamadas GetText , um chamador usaria fUpdateAnchor = TRUE.
O número real de caracteres copiados poderá ser menor que cchReq se o número de caracteres entre paStart e paEnd for menor que cchReq.
O comportamento de GetText não é afetado por nenhum limite de região coberto pelo texto retornado.
Requisitos
| Cliente mínimo com suporte | Windows 2000 Professional [aplicativos da área de trabalho | Aplicativos UWP] |
| Servidor mínimo com suporte | Windows 2000 Server [aplicativos da área de trabalho | Aplicativos UWP] |
| Plataforma de Destino | Windows |
| Cabeçalho | textstor.h |
| DLL | Msctf.dll |
| Redistribuível | TSF 1.0 no Windows 2000 Professional |