Método ITextProvider::GetSelection (uiautomationcore.h)

Artigo
08/26/2023

Recupera uma coleção de intervalos de texto que representa o texto selecionado no momento em um controle baseado em texto.

Sintaxe

HRESULT GetSelection(
  [out, retval] SAFEARRAY **pRetVal
);

Parâmetros

[out, retval] pRetVal

Tipo: SAFEARRAY**

Recebe o endereço de uma matriz de ponteiros para as interfaces ITextRangeProvider dos intervalos de texto, um para cada intervalo de texto selecionado. Este parâmetro é passado não inicializado.

Valor retornado

Tipo: HRESULT

Se o método for bem-sucedido, ele retornará S_OK. Caso contrário, ele retornará um código de erro HRESULT.

Comentários

Para provedores de Automação da Interface do Usuário que dão suporte à seleção de texto, o provedor deve implementar esse método e também retornar um valor ITextProvider::SupportedTextSelection .

Se o controle contiver apenas um único intervalo de texto selecionado, a matriz pRetVal deverá conter um único intervalo de texto.

Se o controle contiver um ponto de inserção de texto, mas nenhum texto for selecionado, a matriz pRetVal deverá conter um intervalo de texto degenerado (vazio) na posição do ponto de inserção de texto.

Se o controle não contiver texto selecionado ou se o controle não contiver um ponto de inserção de texto, defina pRetVal como NULL.

Requisitos


Cliente mínimo com suporte	Windows XP [aplicativos da área de trabalho \| aplicativos UWP]
Servidor mínimo com suporte	Windows Server 2003 [aplicativos da área de trabalho \| Aplicativos UWP]
Plataforma de Destino	Windows
Cabeçalho	uiautomationcore.h (include UIAutomation.h)