Método ITfContext::GetSelection (msctf.h)

Obtém a seleção dentro do documento.

Sintaxe

HRESULT GetSelection(
  [in]  TfEditCookie ec,
  [in]  ULONG        ulIndex,
  [in]  ULONG        ulCount,
  [out] TF_SELECTION *pSelection,
  [out] ULONG        *pcFetched
);

Parâmetros

[in] ec

Contém um cookie de edição que identifica a sessão de edição. Esse é o valor passado para ITfEditSession::D oEditSession.

[in] ulIndex

Especifica o índice baseado em zero da primeira seleção a ser obtida. Use TF_DEFAULT_SELECTION para obter a seleção padrão. Se TF_DEFAULT_SELECTION for usado, somente uma seleção será obtida.

[in] ulCount

Especifica o número máximo de seleções a serem obtidas.

[out] pSelection

Uma matriz de estruturas TF_SELECTION que recebe os dados para cada seleção. A matriz deve ser capaz de conter pelo menos elementos ulCount .

[out] pcFetched

Ponteiro para um valor ULONG que recebe o número de seleções obtidas.

Valor retornado

Esse método pode retornar um desses valores.

Valor	Descrição
S_OK	O método foi bem-sucedido.
TF_E_NOSELECTION	O documento não tem seleção.
TF_E_NOLOCK	O cookie em ec é inválido.
TF_E_DISCONNECTED	O contexto não está em uma pilha de documentos.
E_INVALIDARG	Um ou mais parâmetros são inválidos.
E_OUTOFMEMORY	Ocorreu uma falha de alocação de memória.

Comentários

Uma seleção é um intervalo realçado de texto ou um ponto de inserção se o intervalo estiver vazio, que identifica a área de foco do usuário em um documento.

Se esse método for bem-sucedido, o chamador deverá liberar o membro de intervalo de todas as estruturas TF_SELECTION obtidas.

Normalmente, um contexto dá suporte apenas a uma única seleção. No entanto, é possível que um contexto dê suporte a várias seleções simultâneas. Esse método pode ser usado para obter várias seleções.

Exemplos

HRESULT         hr;
TF_SELECTION    tfSel;
ULONG           uFetched;

//Obtain the default selection. 
hr = pContext->GetSelection(ec, TF_DEFAULT_SELECTION, 1, &tfSel, &uFetched);
if(SUCCEEDED(hr) && (uFetched > 0))
{
    //Work with the selection. 
    
    //Release the selection range object. 
    tfSel.range->Release();
}

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	msctf.h
DLL	Msctf.dll
Redistribuível	TSF 1.0 no Windows 2000 Professional

Confira também

Interface ITfContext, ITfEditSession::D oEditSession, estrutura TF_SELECTION, ITfContext::SetSelection