Fungsi ScrollWindow (winuser.h)

Artikel
03/04/2024

Fungsi ScrollWindow menggulir konten area klien jendela yang ditentukan.

Catatan Fungsi ScrollWindow disediakan untuk kompatibilitas mundur. Aplikasi baru harus menggunakan fungsi ScrollWindowEx .

Sintaks

BOOL ScrollWindow(
  [in] HWND       hWnd,
  [in] int        XAmount,
  [in] int        YAmount,
  [in] const RECT *lpRect,
  [in] const RECT *lpClipRect
);

Parameter

[in] hWnd

Jenis: HWND

Tangani ke jendela tempat area klien akan digulir.

[in] XAmount

Jenis: int

Menentukan jumlah, dalam unit perangkat, dari pengguliran horizontal. Jika jendela yang digulir memiliki gaya CS_OWNDC atau CS_CLASSDC , parameter ini menggunakan unit logis daripada unit perangkat. Parameter ini harus berupa nilai negatif untuk menggulir konten jendela ke kiri.

[in] YAmount

Jenis: int

Menentukan jumlah, dalam unit perangkat, dari pengguliran vertikal. Jika jendela yang digulir memiliki gaya CS_OWNDC atau CS_CLASSDC , parameter ini menggunakan unit logis daripada unit perangkat. Parameter ini harus berupa nilai negatif untuk menggulir konten jendela ke atas.

[in] lpRect

Jenis: const RECT*

Arahkan ke struktur RECT yang menentukan bagian area klien yang akan digulirkan. Jika parameter ini NULL, seluruh area klien akan digulirkan.

[in] lpClipRect

Jenis: const RECT*

Penunjuk ke struktur RECT yang berisi koordinat persegi panjang kliping. Hanya bit perangkat dalam persegi panjang kliping yang terpengaruh. Bit yang digulir dari luar persegi panjang ke bagian dalam dicat; bit yang digulir dari dalam persegi panjang ke luar tidak dicat.

Nilai kembali

Jenis: BOOL

Jika fungsi berhasil, nilai yang dikembalikan bukan nol.

Jika fungsi gagal, nilai yang dikembalikan adalah nol. Untuk mendapatkan informasi kesalahan yang diperluas, hubungi GetLastError.

Keterangan

Jika tanda sisipan berada di jendela yang sedang digulir, ScrollWindow secara otomatis menyembunyikan tanda sisipan untuk mencegahnya dihapus lalu memulihkan tanda sisipan setelah pengguliran selesai. Posisi tanda sisipan disesuaikan dengan sesuai.

Area yang diungkap oleh ScrollWindow tidak dicat ulang, tetapi digabungkan ke dalam wilayah pembaruan jendela. Aplikasi akhirnya menerima pesan WM_PAINT yang memberi tahu bahwa wilayah tersebut harus dicat ulang. Untuk mengecat ulang area yang tidak terungkap pada saat yang sama saat pengguliran sedang beraksi, panggil fungsi UpdateWindow segera setelah memanggil ScrollWindow.

Jika parameter lpRectADALAH NULL, posisi setiap jendela anak di jendela diimbangi dengan jumlah yang ditentukan oleh parameter XAmount dan YAmount ; area tidak valid (tidak dicat) di jendela juga diimbangi. ScrollWindow lebih cepat ketika lpRectADALAH NULL.

Jika lpRect bukan NULL, posisi jendela anak tidak diubah dan area yang tidak valid di jendela tidak diimbangi. Untuk mencegah masalah pembaruan saat lpRect bukan NULL, panggil UpdateWindow untuk mengecat ulang jendela sebelum memanggil ScrollWindow.

Contoh

Misalnya, lihat Menggulir Teks dengan Pesan WM_PAINT.

Persyaratan

Persyaratan	Nilai
Klien minimum yang didukung	Windows Vista [hanya aplikasi desktop]
Server minimum yang didukung	Windows Server 2003 [hanya aplikasi desktop]
Target Platform	Windows
Header	winuser.h (termasuk Windows.h)
Pustaka	User32.lib
DLL	User32.dll
Set API	ext-ms-win-ntuser-window-l1-1-4 (diperkenalkan dalam Windows 10, versi 10.0.14393)