Fungsi SetScrollPos (winuser.h)

Artikel
08/28/2023

Fungsi SetScrollPos mengatur posisi kotak gulir (jempol) di bilah gulir yang ditentukan dan, jika diminta, menggambar ulang bilah gulir untuk mencerminkan posisi baru kotak gulir.

Catatan Fungsi SetScrollPos disediakan untuk kompatibilitas mundur. Aplikasi baru harus menggunakan fungsi SetScrollInfo .

Sintaks

int SetScrollPos(
  [in] HWND hWnd,
  [in] int  nBar,
  [in] int  nPos,
  [in] BOOL bRedraw
);

Parameter

[in] hWnd

Jenis: HWND

Tangani ke kontrol bilah gulir atau jendela dengan bilah gulir standar, tergantung pada nilai parameter nBar .

[in] nBar

Jenis: int

Menentukan bilah gulir yang akan diatur. Parameter ini bisa menjadi salah satu nilai berikut.

Nilai	Makna
SB_CTL	Mengatur posisi kotak gulir dalam kontrol bilah gulir. Parameter hwnd harus menjadi handel ke kontrol bilah gulir.
SB_HORZ	Mengatur posisi kotak gulir di bilah gulir horizontal standar jendela.
SB_VERT	Mengatur posisi kotak gulir di bilah gulir vertikal standar jendela.

[in] nPos

Jenis: int

Menentukan posisi baru kotak gulir. Posisi harus berada dalam rentang gulir. Untuk informasi selengkapnya tentang rentang gulir, lihat fungsi SetScrollRange .

[in] bRedraw

Jenis: BOOL

Menentukan apakah bilah gulir digambar ulang untuk mencerminkan posisi kotak gulir baru. Jika parameter ini TRUE, bilah gulir akan digambar ulang. Jika FALSE, bilah gulir tidak digambar ulang.

Mengembalikan nilai

Jenis: int

Jika fungsi berhasil, nilai yang dikembalikan adalah posisi sebelumnya dari kotak gulir.

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

Keterangan

Jika bilah gulir digambar ulang oleh panggilan berikutnya ke fungsi lain, mengatur parameter bRedraw ke FALSE akan berguna.

Karena pesan yang menunjukkan posisi bilah gulir, WM_HSCROLL dan WM_VSCROLL, dibatasi hingga 16 bit data posisi, aplikasi yang hanya mengandalkan pesan tersebut untuk data posisi memiliki nilai maksimum praktis 65.535 untuk parameter nPos fungsi SetScrollPos.

Namun, karena fungsi SetScrollInfo, SetScrollPos, SetScrollRange, GetScrollInfo, GetScrollPos, dan GetScrollRange mendukung data posisi bilah gulir 32-bit, ada cara untuk menghindari penghadang 16-bit pesan WM_HSCROLL dan WM_VSCROLL . Lihat GetScrollInfo untuk deskripsi teknik.

Jika parameter nBar SB_CTL dan jendela yang ditentukan oleh parameter hWnd bukan kontrol bilah gulir sistem, sistem mengirim pesan SBM_SETPOS ke jendela untuk mengatur informasi bilah gulir. Ini memungkinkan SetScrollPos beroperasi pada kontrol kustom yang meniru bilah gulir. Jika jendela tidak menangani pesan SBM_SETPOS , fungsi SetScrollPos gagal.

Persyaratan


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 (sertakan Windows.h)
Pustaka	User32.lib
DLL	User32.dll
Set API	ext-ms-win-ntuser-misc-l1-2-0 (diperkenalkan di Windows 8.1)