Função ScrollWindow (winuser.h)
A função ScrollWindow rola o conteúdo da área de cliente da janela especificada.
Sintaxe
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
Identificador para a janela em que a área do cliente deve ser rolada.
[in] XAmount
Tipo: int
Especifica a quantidade, em unidades de dispositivo, da rolagem horizontal. Se a janela que está sendo rolada tiver o estilo CS_OWNDC ou CS_CLASSDC , esse parâmetro usará unidades lógicas em vez de unidades de dispositivo. Esse parâmetro deve ser um valor negativo para rolar o conteúdo da janela para a esquerda.
[in] YAmount
Tipo: int
Especifica a quantidade, em unidades de dispositivo, da rolagem horizontal. Se a janela que está sendo rolada tiver o estilo CS_OWNDC ou CS_CLASSDC , esse parâmetro usará unidades lógicas em vez de unidades de dispositivo. Esse parâmetro deve ser um valor negativo para rolar o conteúdo da janela para cima.
[in] lpRect
Tipo: const RECT*
Ponteiro para a estrutura RECT que especifica a parte da área do cliente a ser rolada. Se esse parâmetro for NULL, toda a área do cliente será rolada.
[in] lpClipRect
Tipo: const RECT*
Ponteiro para a estrutura RECT que contém as coordenadas do retângulo de recorte. Somente os bits de dispositivo dentro do retângulo de recorte são afetados. Os bits rolados do lado de fora do retângulo para dentro são pintados; bits rolados de dentro do retângulo para fora não são pintados.
Retornar valor
Tipo: BOOL
Se a função for bem-sucedida, o valor retornado será diferente de zero.
Se a função falhar, o valor retornado será zero. Para obter informações de erro estendidas, chame GetLastError.
Comentários
Se o cursor estiver na janela que está sendo rolada, ScrollWindow ocultará automaticamente o cursor para evitar que ele seja apagado e, em seguida, restaurará o cursor após a conclusão da rolagem. A posição do cursor é ajustada adequadamente.
A área descoberta por ScrollWindow não é repintada, mas é combinada na região de atualização da janela. O aplicativo eventualmente recebe uma mensagem WM_PAINT notificando-o de que a região deve ser repintada. Para repintar a área descoberta ao mesmo tempo em que a rolagem está em ação, chame a função UpdateWindow imediatamente após chamar ScrollWindow.
Se o parâmetro lpRect for NULL, as posições de qualquer janela filho na janela serão deslocadas pela quantidade especificada pelos parâmetros XAmount e YAmount ; áreas inválidas (não pagas) na janela também são deslocadas. ScrollWindow é mais rápido quando lpRect é NULL.
Se lpRect não for NULL, as posições das janelas filho não serão alteradas e as áreas inválidas na janela não serão deslocadas. Para evitar problemas de atualização quando lpRect não for NULL, chame UpdateWindow para repintar a janela antes de chamar ScrollWindow.
Exemplos
Para obter um exemplo, consulte Rolando texto com a mensagem WM_PAINT.
Requisitos
| Requisito | Valor |
|---|---|
| Cliente mínimo com suporte | Windows Vista [somente aplicativos da área de trabalho] |
| Servidor mínimo com suporte | Windows Server 2003 [somente aplicativos da área de trabalho] |
| Plataforma de Destino | Windows |
| Cabeçalho | winuser.h (inclua Windows.h) |
| Biblioteca | User32.lib |
| DLL | User32.dll |
| Conjunto de APIs | ext-ms-win-ntuser-window-l1-1-4 (introduzido no Windows 10, versão 10.0.14393) |
Confira também
Outros recursos
Referência