Función ScrollWindow (winuser.h)

Artículo
03/04/2024

La función ScrollWindow desplaza el contenido del área de cliente de la ventana especificada.

Nota La función ScrollWindow se proporciona para la compatibilidad con versiones anteriores. Las nuevas aplicaciones deben usar la función ScrollWindowEx .

Sintaxis

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

Parámetros

[in] hWnd

Tipo: HWND

Controlar hasta la ventana donde se va a desplazar el área de cliente.

[in] XAmount

Tipo: int

Especifica la cantidad, en unidades de dispositivo, de desplazamiento horizontal. Si la ventana que se desplaza tiene el estilo CS_OWNDC o CS_CLASSDC , este parámetro usa unidades lógicas en lugar de unidades de dispositivo. Este parámetro debe ser un valor negativo para desplazar el contenido de la ventana a la izquierda.

[in] YAmount

Tipo: int

Especifica la cantidad, en unidades de dispositivo, de desplazamiento vertical. Si la ventana que se desplaza tiene el estilo CS_OWNDC o CS_CLASSDC , este parámetro usa unidades lógicas en lugar de unidades de dispositivo. Este parámetro debe ser un valor negativo para desplazar el contenido de la ventana hacia arriba.

[in] lpRect

Tipo: const RECT*

Puntero a la estructura RECT que especifica la parte del área de cliente que se va a desplazar. Si este parámetro es NULL, se desplaza el área de cliente completa.

[in] lpClipRect

Tipo: const RECT*

Puntero a la estructura RECT que contiene las coordenadas del rectángulo de recorte. Solo se ven afectados los bits de dispositivo dentro del rectángulo de recorte. Los bits que se desplazan desde fuera del rectángulo hasta el interior se pintan; los bits se desplazan desde el interior del rectángulo hasta el exterior no se pintan.

Valor devuelto

Tipo: BOOL

Si la función se realiza correctamente, el valor devuelto es distinto de cero.

Si la función no se realiza correctamente, el valor devuelto es cero. Para obtener información de error extendida, llame a GetLastError.

Comentarios

Si el símbolo de intercalación está en la ventana que se está desplazando, ScrollWindow oculta automáticamente el símbolo de intercalación para evitar que se borre y, a continuación, restaura el símbolo de intercalación después de que finalice el desplazamiento. La posición del cursor de inserción se ajusta en consecuencia.

El área descubierta por ScrollWindow no se vuelve a pintar, pero se combina en la región de actualización de la ventana. La aplicación recibe finalmente un mensaje de WM_PAINT que le notifica que la región debe volver a pintarse. Para volver a dibujar el área descubierta al mismo tiempo que el desplazamiento está en acción, llame a la función UpdateWindow inmediatamente después de llamar a ScrollWindow.

Si el parámetro lpRect es NULL, las posiciones de cualquier ventana secundaria de la ventana se desplazan por la cantidad especificada por los parámetros XAmount e YAmount ; Las áreas no válidas (sin pintar) de la ventana también se desplazan. ScrollWindow es más rápido cuando lpRect es NULL.

Si lpRect no es NULL, las posiciones de las ventanas secundarias no cambian y las áreas no válidas de la ventana no se desplazan. Para evitar problemas de actualización cuando lpRect no es NULL, llame a UpdateWindow para volver a dibujar la ventana antes de llamar a ScrollWindow.

Ejemplos

Para obtener un ejemplo, vea Scrolling Text with the WM_PAINT Message.

Requisitos

Requisito	Value
Cliente mínimo compatible	Windows Vista [solo aplicaciones de escritorio]
Servidor mínimo compatible	Windows Server 2003 [solo aplicaciones de escritorio]
Plataforma de destino	Windows
Encabezado	winuser.h (incluya Windows.h)
Library	User32.lib
Archivo DLL	User32.dll
Conjunto de API	ext-ms-win-ntuser-window-l1-1-4 (introducido en Windows 10, versión 10.0.14393)