GetScrollPos-Funktion (winuser.h)

Artikel
08/27/2023

Die GetScrollPos-Funktion ruft die aktuelle Position des Bildlauffelds (Thumb) in der angegebenen Bildlaufleiste ab. Die aktuelle Position ist ein relativer Wert, der vom aktuellen Bildlaufbereich abhängt. Wenn der Bildlaufbereich beispielsweise 0 bis 100 ist und sich das Bildlauffeld in der Mitte des Balkens befindet, ist die aktuelle Position 50.

Hinweis Die GetScrollPos-Funktion wird aus Gründen der Abwärtskompatibilität bereitgestellt. Neue Anwendungen sollten die GetScrollInfo-Funktion verwenden.

Syntax

int GetScrollPos(
  [in] HWND hWnd,
  [in] int  nBar
);

Parameter

[in] hWnd

Typ: HWND

Führen Sie je nach Wert des nBar-Parameters ein Bildlaufleistensteuerelement oder ein Fenster mit einer Standardlaufleiste durch.

[in] nBar

Typ: int

Gibt die zu untersuchende Bildlaufleiste an. Dieser Parameter kann einen der folgenden Werte annehmen.

Wert	Bedeutung
SB_CTL	Ruft die Position des Bildlauffelds in einem Bildlaufleistensteuerelement ab. Der hWnd-Parameter muss das Handle für das Scrollleistensteuerelement sein.
SB_HORZ	Ruft die Position des Bildlauffelds in der horizontalen Standardlaufleiste eines Fensters ab.
SB_VERT	Ruft die Position des Bildlauffelds in der vertikalen Standardlaufleiste eines Fensters ab.

Rückgabewert

Typ: int

Wenn die Funktion erfolgreich ist, ist der Rückgabewert die aktuelle Position des Scrollfelds.

Wenn die Funktion fehlerhaft ist, ist der Rückgabewert null. Um erweiterte Fehlerinformationen zu erhalten, rufen Sie GetLastError auf.

Hinweise

Mit der GetScrollPos-Funktion können Anwendungen 32-Bit-Scrollpositionen verwenden. Obwohl die Meldungen, die die Position der Bildlaufleiste angeben, WM_HSCROLL und WM_VSCROLL, auf 16 Bit von Positionsdaten beschränkt sind, unterstützen die Funktionen SetScrollPos, SetScrollRange, GetScrollPos und GetScrollRange 32-Bit-Bildlaufleistenpositionsdaten. Daher kann eine Anwendung GetScrollPos aufrufen, während sie entweder die WM_HSCROLL oder WM_VSCROLL Nachrichten verarbeitet, um 32-Bit-Bildlaufleistenpositionsdaten zu erhalten.

Verwenden Sie die GetScrollInfo-Funktion, um die 32-Bit-Position des Bildlauffelds (Thumb) während eines SB_THUMBTRACK Anforderungscodes in einer WM_HSCROLL- oder WM_VSCROLL-Nachricht abzurufen.

Wenn der nBar-Parameter SB_CTL ist und das durch den hWnd-Parameter angegebene Fenster kein Systemlaufleistensteuerelement ist, sendet das System die SBM_GETPOS Meldung an das Fenster, um Bildlaufleisteninformationen abzurufen. Dadurch kann GetScrollPos mit einem benutzerdefinierten Steuerelement arbeiten, das eine Bildlaufleiste nachahmt. Wenn das Fenster die SBM_GETPOS Meldung nicht verarbeitet, schlägt die GetScrollPos-Funktion fehl.

Anforderungen


Unterstützte Mindestversion (Client)	Windows Vista [nur Desktop-Apps]
Unterstützte Mindestversion (Server)	Windows Server 2003 [nur Desktop-Apps]
Zielplattform	Windows
Kopfzeile	winuser.h (einschließlich Windows.h)
Bibliothek	User32.lib
DLL	User32.dll
APIs	ext-ms-win-ntuser-misc-l1-2-0 (eingeführt in Windows 8.1)