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

Article
08/24/2023

Obtient la sélection dans le document.

Syntaxe

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

Paramètres

[in] ec

Contient un cookie de modification qui identifie la session de modification. Il s’agit de la valeur passée à ITfEditSession::D oEditSession.

[in] ulIndex

Spécifie l’index de base zéro de la première sélection à obtenir. Utilisez TF_DEFAULT_SELECTION pour obtenir la sélection par défaut. Si TF_DEFAULT_SELECTION est utilisé, une seule sélection est obtenue.

[in] ulCount

Spécifie le nombre maximal de sélections à obtenir.

[out] pSelection

Tableau de structures TF_SELECTION qui reçoit les données pour chaque sélection. Le tableau doit être en mesure de contenir au moins des éléments ulCount .

[out] pcFetched

Pointeur vers une valeur ULONG qui reçoit le nombre de sélections obtenues.

Valeur retournée

Cette méthode peut retourner l’une de ces valeurs.

Valeur	Description
S_OK	La méthode a réussi.
TF_E_NOSELECTION	Le document n’a pas de sélection.
TF_E_NOLOCK	Le cookie dans ec n’est pas valide.
TF_E_DISCONNECTED	Le contexte ne se trouve pas sur une pile de documents.
E_INVALIDARG	Un ou plusieurs paramètres ne sont pas valides.
E_OUTOFMEMORY	Un échec d’allocation de mémoire s’est produit.

Notes

Une sélection est une plage de texte mise en surbrillance, ou un point d’insertion si la plage est vide, qui identifie la zone de focus utilisateur dans un document.

Si cette méthode réussit, l’appelant doit libérer le membre de plage de toutes les structures TF_SELECTION obtenues.

Normalement, un contexte ne prend en charge qu’une seule sélection. Toutefois, un contexte peut prendre en charge plusieurs sélections simultanées. Cette méthode peut être utilisée pour obtenir plusieurs sélections.

Exemples


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

Spécifications


Client minimal pris en charge	Windows 2000 Professionnel [applications de bureau \| Applications UWP]
Serveur minimal pris en charge	Windows 2000 Server [applications de bureau \| Applications UWP]
Plateforme cible	Windows
En-tête	msctf.h
DLL	Msctf.dll
Composant redistribuable	TSF 1.0 sur Windows 2000 Professionnel

Voir aussi

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

Partager via