Metode ITfReadOnlyProperty::EnumRanges (msctf.h)

Artikel
08/24/2023

Mendapatkan enumerasi rentang yang berisi nilai unik properti dalam rentang yang diberikan.

Sintaks

HRESULT EnumRanges(
  [in]  TfEditCookie  ec,
  [out] IEnumTfRanges **ppEnum,
  [in]  ITfRange      *pTargetRange
);

Parameter

[in] ec

Berisi cookie edit yang mengidentifikasi konteks edit. Ini diperoleh dari ITfDocumentMgr::CreateContext atau ITfEditSession::D oEditSession.

[out] ppEnum

Arahkan ke penunjuk antarmuka IEnumTfRanges yang menerima objek enumerator. Pemanggil harus melepaskan objek ini ketika tidak lagi diperlukan.

[in] pTargetRange

Penunjuk ke antarmuka ITfRange yang menentukan rentang untuk memindai nilai properti unik. Parameter ini bersifat opsional dan dapat berupa NULL. Untuk informasi lebih lanjut, lihat bagian Keterangan.

Menampilkan nilai

Metode ini dapat mengembalikan salah satu nilai ini.

Nilai	Deskripsi
S_OK	Metode berhasil.
E_INVALIDARG	Satu atau beberapa parameter tidak valid.
E_OUTOFMEMORY	Terjadi kegagalan alokasi memori.
E_FAIL	Terjadi kesalahan yang tidak ditentukan. Catatan Jika aplikasi tidak menerapkan ITextStoreACP::FindNextAttrTransition, ITfReadOnlyProperty::EnumRanges gagal dengan E_FAIL.
TF_E_NOLOCK	Konteks edit yang diidentifikasi oleh ec tidak memiliki kunci baca-saja atau baca/tulis.

Keterangan

Catatan: Jika aplikasi tidak menerapkan ITextStoreACP::FindNextAttrTransition, ITfReadOnlyProperty::EnumRanges gagal dengan E_FAIL.

Enumerator yang diperoleh dengan metode ini akan berisi rentang untuk setiap nilai unik, termasuk nilai kosong, dari properti yang ditentukan. Misalnya, properti warna hipotetis dapat diterapkan ke teks yang ditandai berikut:


COLOR:      RR      GGGGGGGG
TEXT:  this is some colored text

Ketika ITfReadOnlyProperty::EnumRanges dipanggil dengan pTargetRange diatur ke rentang ini, enumerator akan berisi lima rentang.

Indeks Rentang	Nilai Properti Warna	Teks Rentang
0	<kosong>	"ini"
1	R	"is"
2	<kosong>	" beberapa "
3	G	"berwarna"
4	<kosong>	"teks"

Jika pTargetRangeADALAH NULL, maka enumerator akan dimulai dan diakhir dengan rentang pertama dan terakhir yang berisi nilai properti yang tidak kosong dalam konteks. Menentukan NULL untuk pTargetRange dalam contoh di atas akan menghasilkan enumerator dengan tiga rentang.

Indeks Rentang	Nilai Properti Warna	Teks Dalam Rentang
0	R	"is"
1	<kosong>	" beberapa "
2	G	"berwarna"

Rentang yang dijumlahkan akan dimulai dan diakhiri dengan jangkar awal dan akhir pTargetRange, bahkan jika salah satu jangkar diposisikan di tengah properti.

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