Metodo ITfContext::GetSelection (msctf.h)

Ottiene la selezione all'interno del documento.

Sintassi

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

Parametri

[in] ec

Contiene un cookie di modifica che identifica la sessione di modifica. Questo è il valore passato a ITfEditSession::D oEditSession.

[in] ulIndex

Specifica l'indice in base zero della prima selezione da ottenere. Usare TF_DEFAULT_SELECTION per ottenere la selezione predefinita. Se viene utilizzata TF_DEFAULT_SELECTION, viene ottenuta una sola selezione.

[in] ulCount

Specifica il numero massimo di selezioni da ottenere.

[out] pSelection

Matrice di strutture TF_SELECTION che ricevono i dati per ogni selezione. La matrice deve essere in grado di contenere almeno gli elementi ulCount .

[out] pcFetched

Puntatore a un valore ULONG che riceve il numero di selezioni ottenute.

Valore restituito

Questo metodo può restituire uno di questi valori.

Valore	Descrizione
S_OK	Il metodo è stato eseguito correttamente.
TF_E_NOSELECTION	Il documento non ha alcuna selezione.
TF_E_NOLOCK	Il cookie in ec non è valido.
TF_E_DISCONNECTED	Il contesto non è in uno stack di documenti.
E_INVALIDARG	Uno o più parametri non sono validi.
E_OUTOFMEMORY	Si è verificato un errore di allocazione della memoria.

Commenti

Una selezione è un intervallo evidenziato di testo o un punto di inserimento se l'intervallo è vuoto, che identifica l'area dello stato attivo utente all'interno di un documento.

Se questo metodo ha esito positivo, il chiamante deve rilasciare il membro dell'intervallo di tutte le strutture TF_SELECTION ottenute.

In genere, un contesto supporta solo una singola selezione. È tuttavia possibile che un contesto supporti più selezioni simultanee. Questo metodo può essere usato per ottenere più selezioni.

Esempio

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();
}

Requisiti

Client minimo supportato	Windows 2000 Professional [app desktop | App UWP]
Server minimo supportato	Windows 2000 Server [app desktop | App UWP]
Piattaforma di destinazione	Windows
Intestazione	msctf.h
DLL	Msctf.dll
Componente ridistribuibile	TSF 1.0 in Windows 2000 Professional

Vedi anche

Interfaccia ITfContext, ITfEditSession::D oEditSession, TF_SELECTION struttura, ITfContext::SetSelection