Funzione ScrollWindow (winuser.h)

Articolo
03/04/2024

La funzione ScrollWindow scorre il contenuto dell'area client della finestra specificata.

Nota La funzione ScrollWindow viene fornita per la compatibilità con le versioni precedenti. Le nuove applicazioni devono usare la funzione ScrollWindowEx .

Sintassi

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

Parametri

[in] hWnd

Tipo: HWND

Gestire la finestra in cui è necessario scorrere l'area client.

[in] XAmount

Tipo: int

Specifica la quantità, nelle unità di dispositivo, dello scorrimento orizzontale. Se la finestra in corso di scorrimento ha lo stile CS_OWNDC o CS_CLASSDC , questo parametro usa unità logiche anziché unità dispositivo. Questo parametro deve essere un valore negativo per scorrere il contenuto della finestra a sinistra.

[in] YAmount

Tipo: int

Specifica la quantità, nelle unità del dispositivo, dello scorrimento verticale. Se la finestra in corso di scorrimento ha lo stile CS_OWNDC o CS_CLASSDC , questo parametro usa unità logiche anziché unità dispositivo. Questo parametro deve essere un valore negativo per scorrere il contenuto della finestra verso l'alto.

[in] lpRect

Tipo: const RECT*

Puntatore alla struttura RECT che specifica la parte dell'area client da scorrere. Se questo parametro è NULL, l'intera area client viene scorrevole.

[in] lpClipRect

Tipo: const RECT*

Puntatore alla struttura RECT contenente le coordinate del rettangolo di ritaglio. Vengono interessati solo i bit del dispositivo all'interno del rettangolo di ritaglio. I bit scorrevoli dall'esterno del rettangolo all'interno sono dipinti; i bit scorrevoli dall'interno del rettangolo all'esterno non sono dipinti.

Valore restituito

Tipo: BOOL

Se la funzione ha esito positivo, il valore restituito è diverso da zero.

Se la funzione ha esito negativo, il valore restituito è zero. Per informazioni dettagliate sull'errore, chiamare GetLastError.

Commenti

Se il caret si trova nella finestra a scorrimento, ScrollWindow nasconde automaticamente il cursore per impedire che venga cancellato e quindi ripristina il punto di scorrimento dopo il completamento dello scorrimento. La posizione del caret viene modificata di conseguenza.

L'area individuata da ScrollWindow non è riintuta, ma viene combinata nell'area di aggiornamento della finestra. L'applicazione riceve infine un messaggio WM_PAINT notificando che l'area deve essere riinteduta. Per ricompigliare l'area individuata allo stesso tempo in cui lo scorrimento è in azione, chiamare la funzione UpdateWindow immediatamente dopo aver chiamato ScrollWindow.

Se il parametro lpRect è NULL, le posizioni di qualsiasi finestra figlio nella finestra sono offset dalla quantità specificata dai parametri XAmount e YAmount; le aree non valide (non dipinte) nella finestra sono anche offset. ScrollWindow è più veloce quando lpRect è NULL.

Se lpRect non è NULL, le posizioni delle finestre figlio non vengono modificate e le aree non valide nella finestra non sono offset. Per evitare problemi di aggiornamento quando lpRect non è NULL, chiamare UpdateWindow per ricreare la finestra prima di chiamare ScrollWindow.

Esempio

Per un esempio, vedere Scorrimento del testo con il messaggio WM_PAINT.

Requisiti

Requisito	Valore
Client minimo supportato	Windows Vista [solo app desktop]
Server minimo supportato	Windows Server 2003 [solo app desktop]
Piattaforma di destinazione	Windows
Intestazione	winuser.h (include Windows.h)
Libreria	User32.lib
DLL	User32.dll
Set di API	ext-ms-win-ntuser-window-l1-1-4 (introdotta in Windows 10, versione 10.0.14393)