ScrollWindow, fonction (winuser.h)

Article
08/28/2023

La fonction ScrollWindow fait défiler le contenu de la zone cliente de la fenêtre spécifiée.

Note La fonction ScrollWindow est fournie pour la compatibilité descendante. Les nouvelles applications doivent utiliser la fonction ScrollWindowEx .

Syntaxe

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

Paramètres

[in] hWnd

Type : HWND

Gérez jusqu’à la fenêtre où la zone cliente doit faire défiler.

[in] XAmount

Type : int

Spécifie la quantité, en unités d’appareil, du défilement horizontal. Si la fenêtre en cours de défilement a le style CS_OWNDC ou CS_CLASSDC , ce paramètre utilise des unités logiques plutôt que des unités d’appareil. Ce paramètre doit être une valeur négative pour faire défiler le contenu de la fenêtre vers la gauche.

[in] YAmount

Type : int

Spécifie la quantité, en unités d’appareil, du défilement vertical. Si la fenêtre en cours de défilement a le style CS_OWNDC ou CS_CLASSDC , ce paramètre utilise des unités logiques plutôt que des unités d’appareil. Ce paramètre doit être une valeur négative pour faire défiler le contenu de la fenêtre vers le haut.

[in] lpRect

Type : const RECT*

Pointeur vers la structure RECT spécifiant la partie de la zone cliente à faire défiler. Si ce paramètre a la valeur NULL, l’ensemble de la zone du client est défilé.

[in] lpClipRect

Type : const RECT*

Pointeur vers la structure RECT contenant les coordonnées du rectangle de découpage. Seuls les bits d’appareil dans le rectangle de découpage sont affectés. Les bits qui défilent de l’extérieur du rectangle vers l’intérieur sont peints ; Les bits qui défilent de l’intérieur du rectangle vers l’extérieur ne sont pas peints.

Valeur retournée

Type : BOOL

Si la fonction réussit, la valeur de retour est différente de zéro.

Si la fonction échoue, la valeur de retour est égale à zéro. Pour obtenir des informations détaillées sur l’erreur, appelez GetLastError.

Remarques

Si l’insertion se trouve dans la fenêtre en cours de défilement, ScrollWindow masque automatiquement l’insertion pour empêcher son effacement, puis restaure l’insertion une fois le défilement terminé. La position d’insertion est ajustée en conséquence.

La zone découverte par ScrollWindow n’est pas repeinte, mais elle est combinée dans la région de mise à jour de la fenêtre. L’application reçoit finalement un message WM_PAINT l’informant que la région doit être repeinte. Pour repeindre la zone découverte en même temps que le défilement est en action, appelez la fonction UpdateWindow immédiatement après avoir appelé ScrollWindow.

Si le paramètre lpRect a la valeur NULL, les positions des fenêtres enfants dans la fenêtre sont décalées par la quantité spécifiée par les paramètres XAmount et YAmount ; Les zones non valides (non peintes) de la fenêtre sont également décalées. ScrollWindow est plus rapide lorsque lpRect a la valeur NULL.

Si lpRect n’a pas la valeur NULL, les positions des fenêtres enfants ne sont pas modifiées et les zones non valides de la fenêtre ne sont pas décalées. Pour éviter les problèmes de mise à jour lorsque lpRect n’a pas la valeur NULL, appelez UpdateWindow pour repeindre la fenêtre avant d’appeler ScrollWindow.

Exemples

Pour obtenir un exemple, consultez Défilement de texte avec le message WM_PAINT.

Configuration requise

Condition requise	Valeur
Client minimal pris en charge	Windows Vista [applications de bureau uniquement]
Serveur minimal pris en charge	Windows Server 2003 [applications de bureau uniquement]
Plateforme cible	Windows
En-tête	winuser.h (inclure Windows.h)
Bibliothèque	User32.lib
DLL	User32.dll
Ensemble d’API	ext-ms-win-ntuser-window-l1-1-4 (introduit dans Windows 10, version 10.0.14393)