ITfContext::GetSelection-Methode (msctf.h)

Artikel
08/24/2023

Ruft die Auswahl innerhalb des Dokuments ab.

Syntax

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

Parameter

[in] ec

Enthält ein Bearbeitungscookies, das die Bearbeitungssitzung identifiziert. Dies ist der Wert, der an ITfEditSession::D oEditSession übergeben wird.

[in] ulIndex

Gibt den nullbasierten Index der ersten abzurufenden Auswahl an. Verwenden Sie TF_DEFAULT_SELECTION, um die Standardauswahl abzurufen. Wenn TF_DEFAULT_SELECTION verwendet wird, wird nur eine Auswahl abgerufen.

[in] ulCount

Gibt die maximale Anzahl der abzurufenden Auswahlen an.

[out] pSelection

Ein Array von TF_SELECTION Strukturen, das die Daten für jede Auswahl empfängt. Das Array muss mindestens ulCount-Elemente enthalten können.

[out] pcFetched

Zeiger auf einen ULONG-Wert, der die Anzahl der abgerufenen Auswahlen empfängt.

Rückgabewert

Diese Methode kann einen dieser Werte zurückgeben.

Wert	BESCHREIBUNG
S_OK	Die Methode war erfolgreich.
TF_E_NOSELECTION	Das Dokument hat keine Auswahl.
TF_E_NOLOCK	Das Cookie in ec ist ungültig.
TF_E_DISCONNECTED	Der Kontext befindet sich nicht in einem Dokumentstapel.
E_INVALIDARG	Mindestens ein Parameter ist ungültig.
E_OUTOFMEMORY	Ein Speicherbelegungsfehler ist aufgetreten.

Hinweise

Eine Auswahl ist ein hervorgehobener Textbereich oder eine Einfügemarke, wenn der Bereich leer ist, die den Benutzerfokusbereich innerhalb eines Dokuments identifiziert.

Wenn diese Methode erfolgreich ist, muss der Aufrufer den Bereichsmember aller abgerufenen TF_SELECTION-Strukturen freigeben.

Normalerweise unterstützt ein Kontext nur eine einzelne Auswahl. Es ist jedoch möglich, dass ein Kontext mehrere gleichzeitige Auswahlen unterstützt. Diese Methode kann verwendet werden, um mehrere Auswahlmöglichkeiten abzurufen.

Beispiele


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

Anforderungen


Unterstützte Mindestversion (Client)	Windows 2000 Professional [Desktop-Apps \| UWP-Apps]
Unterstützte Mindestversion (Server)	Windows 2000 Server [Desktop-Apps \| UWP-Apps]
Zielplattform	Windows
Kopfzeile	msctf.h
DLL	Msctf.dll
Verteilbare Komponente	TSF 1.0 unter Windows 2000 Professional

Weitere Informationen

ITfContext-Schnittstelle, ITfEditSession::D oEditSession, TF_SELECTION-Struktur, ITfContext::SetSelection

Freigeben über