Metode ITextProvider::GetVisibleRanges (uiautomationcore.h)

Artikel
08/26/2023

Mengambil array rentang teks yang terputang dari kontrol berbasis teks di mana setiap rentang teks mewakili rentang teks yang berdampingan.

Sintaks

HRESULT GetVisibleRanges(
  [out, retval] SAFEARRAY **pRetVal
);

Parameter

[out, retval] pRetVal

Jenis: SAFEARRAY**

Menerima alamat array pointer ke antarmuka ITextRangeProvider dari rentang teks yang terlihat atau array kosong. Referensi NULL tidak pernah dikembalikan. Parameter ini diteruskan tanpa diinisialisasi.

Mengembalikan nilai

Jenis: HRESULT

Jika metode ini berhasil, metode ini mengembalikan S_OK. Jika tidak, kode kesalahan HRESULT akan dikembalikan.

Keterangan

Jika teks yang terlihat terdiri dari satu rentang teks yang berdampingan, array pRetVal harus berisi rentang teks tunggal yang mewakili semua teks yang terlihat.

Jika teks yang terlihat terdiri dari beberapa rentang teks yang berbeda, array pRetVal harus berisi satu rentang teks untuk setiap rentang yang terlihat, dimulai dengan rentang pertama yang terlihat, dan berakhir dengan rentang terakhir yang terlihat. Rentang teks yang tidak terputus-putus dapat terjadi ketika konten kontrol berbasis teks sebagian dikaburkan oleh jendela yang tumpang tindih atau objek lain, atau ketika kontrol berbasis teks dengan beberapa halaman atau kolom memiliki konten yang sebagian digulir keluar dari tampilan.

ITextProvider::GetVisibleRanges harus mengembalikan rentang teks degenerasi (kosong) jika tidak ada teks yang terlihat, jika semua teks digulir keluar dari tampilan, atau jika kontrol berbasis teks tidak berisi teks.

Persyaratan


Klien minimum yang didukung	Windows XP [aplikasi desktop \| Aplikasi UWP]
Server minimum yang didukung	Windows Server 2003 [aplikasi desktop \| Aplikasi UWP]
Target Platform	Windows
Header	uiautomationcore.h (termasuk UIAutomation.h)