Método ITextProvider2::GetCaretRange (uiautomationcore.h)

Fornece um intervalo de texto de comprimento zero no local do cursor que pertence ao controle baseado em texto.

Sintaxe

HRESULT GetCaretRange(
  [out]         BOOL               *isActive,
  [out, retval] ITextRangeProvider **pRetVal
);

Parâmetros

[out] isActive

Tipo: BOOL*

TRUE se o controle baseado em texto que contém o cursor tiver o foco do teclado, caso contrário, FALSE.

[out, retval] pRetVal

Tipo: ITextRangeProvider**

Um intervalo de texto que representa o local atual do cursor que pertence ao controle baseado em texto.

Retornar valor

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

Se o parâmetro isActive for FALSE, o cursor que pertence ao controle baseado em texto poderá não estar no mesmo local que o cursor do sistema.

Esse método recupera um intervalo de texto que um cliente pode usar para localizar o retângulo delimitador do cursor que pertence ao controle baseado em texto ou para localizar o texto próximo ao cursor.

Requisitos

Confira também

ITextProvider2