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

Obtiene la selección dentro del documento.

Sintaxis

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

Parámetros

[in] ec

Contiene una cookie de edición que identifica la sesión de edición. Este es el valor pasado a ITfEditSession::D oEditSession.

[in] ulIndex

Especifica el índice de base cero de la primera selección que se va a obtener. Use TF_DEFAULT_SELECTION para obtener la selección predeterminada. Si se usa TF_DEFAULT_SELECTION, solo se obtiene una selección.

[in] ulCount

Especifica el número máximo de selecciones que se van a obtener.

[out] pSelection

Matriz de estructuras de TF_SELECTION que recibe los datos de cada selección. La matriz debe ser capaz de contener al menos elementos ulCount .

[out] pcFetched

Puntero a un valor ULONG que recibe el número de selecciones obtenidas.

Valor devuelto

Este método puede devolver uno de estos valores.

Valor	Descripción
S_OK	Método realizado correctamente.
TF_E_NOSELECTION	El documento no tiene ninguna selección.
TF_E_NOLOCK	La cookie en ec no es válida.
TF_E_DISCONNECTED	El contexto no está en una pila de documentos.
E_INVALIDARG	Uno o varios parámetros no son válidos.
E_OUTOFMEMORY	Error de asignación de memoria.

Comentarios

Una selección es un intervalo de texto resaltado o un punto de inserción si el intervalo está vacío, que identifica el área de enfoque del usuario dentro de un documento.

Si este método se ejecuta correctamente, el autor de la llamada debe liberar el miembro de intervalo de todas las estructuras de TF_SELECTION obtenidos.

Normalmente, un contexto solo admite una única selección. Sin embargo, es posible que un contexto admita varias selecciones simultáneas. Este método se puede usar para obtener varias selecciones.

Ejemplos

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 compatible	Windows 2000 Professional [aplicaciones de escritorio | Aplicaciones para UWP]
Servidor mínimo compatible	Windows 2000 Server [aplicaciones de escritorio | Aplicaciones para UWP]
Plataforma de destino	Windows
Encabezado	msctf.h
Archivo DLL	Msctf.dll
Redistribuible	TSF 1.0 en Windows 2000 Professional

Consulte también

Interfaz ITfContext, ITfEditSession::D oEditSession, TF_SELECTION estructura, ITfContext::SetSelection