Metode ITfContext::GetSelection (msctf.h)

Artikel
08/24/2023

Mendapatkan pilihan di dalam dokumen.

Sintaks

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

Parameter

[in] ec

Berisi cookie edit yang mengidentifikasi sesi edit. Ini adalah nilai yang diteruskan ke ITfEditSession::D oEditSession.

[in] ulIndex

Menentukan indeks berbasis nol dari pilihan pertama yang akan diperoleh. Gunakan TF_DEFAULT_SELECTION untuk mendapatkan pilihan default. Jika TF_DEFAULT_SELECTION digunakan, hanya satu pilihan yang diperoleh.

[in] ulCount

Menentukan jumlah maksimum pilihan yang akan diperoleh.

[out] pSelection

Array struktur TF_SELECTION yang menerima data untuk setiap pilihan. Array harus dapat menampung setidaknya elemen ulCount .

[out] pcFetched

Penunjuk ke nilai ULONG yang menerima jumlah pilihan yang diperoleh.

Nilai kembali

Metode ini dapat mengembalikan salah satu nilai ini.

Nilai	Deskripsi
S_OK	Metode berhasil.
TF_E_NOSELECTION	Dokumen tidak memiliki pilihan.
TF_E_NOLOCK	Cookie di ec tidak valid.
TF_E_DISCONNECTED	Konteks tidak ada di tumpukan dokumen.
E_INVALIDARG	Satu atau beberapa parameter tidak valid.
E_OUTOFMEMORY	Terjadi kegagalan alokasi memori.

Keterangan

Pilihan adalah rentang teks yang disorot, atau titik penyisipan jika rentang kosong, yang mengidentifikasi area fokus pengguna dalam dokumen.

Jika metode ini berhasil, penelepon harus melepaskan anggota rentang dari semua struktur TF_SELECTION yang diperoleh.

Biasanya, konteks hanya mendukung satu pilihan. Namun, dimungkinkan untuk konteks untuk mendukung beberapa pilihan simultan. Metode ini dapat digunakan untuk mendapatkan beberapa pilihan.

Contoh


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

Persyaratan


Klien minimum yang didukung	Windows 2000 Professional [aplikasi desktop \| Aplikasi UWP]
Server minimum yang didukung	Windows 2000 Server [aplikasi desktop \| Aplikasi UWP]
Target Platform	Windows
Header	msctf.h
DLL	Msctf.dll
Redistribusi	TSF 1.0 di Windows 2000 Professional

Lihat juga

Antarmuka ITfContext, ITfEditSession::D oEditSession, struktur TF_SELECTION, ITfContext::SetSelection

Bagikan melalui